Publish built docs triggered by ebd62d052cd54fccbcf73fedab8ed042752c1dd6
diff --git a/.asf.yaml b/.asf.yaml index e96b43c..75b2262 100644 --- a/.asf.yaml +++ b/.asf.yaml
@@ -29,6 +29,10 @@ rebase: false features: issues: true + protected_branches: + main: + required_pull_request_reviews: + required_approving_review_count: 1 staging: whoami: asf-staging
diff --git a/_sources/autoapi/datafusion/col/index.rst.txt b/_sources/autoapi/datafusion/col/index.rst.txt new file mode 100644 index 0000000..138a35e --- /dev/null +++ b/_sources/autoapi/datafusion/col/index.rst.txt
@@ -0,0 +1,29 @@ +datafusion.col +============== + +.. py:module:: datafusion.col + +.. autoapi-nested-parse:: + + Col class. + + + +Attributes +---------- + +.. autoapisummary:: + + datafusion.col.col + datafusion.col.column + + +Module Contents +--------------- + +.. py:data:: col + :type: Col + +.. py:data:: column + :type: Col +
diff --git a/_sources/autoapi/datafusion/context/index.rst.txt b/_sources/autoapi/datafusion/context/index.rst.txt index 97b5848..12c4965 100644 --- a/_sources/autoapi/datafusion/context/index.rst.txt +++ b/_sources/autoapi/datafusion/context/index.rst.txt
@@ -774,19 +774,25 @@ - .. py:method:: register_udaf(udaf: datafusion.udf.AggregateUDF) -> None + .. py:method:: register_udaf(udaf: datafusion.user_defined.AggregateUDF) -> None Register a user-defined aggregation function (UDAF) with the context. - .. py:method:: register_udf(udf: datafusion.udf.ScalarUDF) -> None + .. py:method:: register_udf(udf: datafusion.user_defined.ScalarUDF) -> None Register a user-defined function (UDF) with the context. - .. py:method:: register_udwf(udwf: datafusion.udf.WindowUDF) -> None + .. py:method:: register_udtf(func: datafusion.user_defined.TableFunction) -> None + + Register a user defined table function. + + + + .. py:method:: register_udwf(udwf: datafusion.user_defined.WindowUDF) -> None Register a user-defined window function (UDWF) with the context.
diff --git a/_sources/autoapi/datafusion/dataframe/index.rst.txt b/_sources/autoapi/datafusion/dataframe/index.rst.txt index 200e796..5262d74 100644 --- a/_sources/autoapi/datafusion/dataframe/index.rst.txt +++ b/_sources/autoapi/datafusion/dataframe/index.rst.txt
@@ -282,6 +282,29 @@ + .. py:method:: fill_null(value: Any, subset: list[str] | None = None) -> DataFrame + + Fill null values in specified columns with a value. + + :param value: Value to replace nulls with. Will be cast to match column type. + :param subset: Optional list of column names to fill. If None, fills all columns. + + :returns: DataFrame with null values replaced where type casting is possible + + .. rubric:: Examples + + >>> df = df.fill_null(0) # Fill all nulls with 0 where possible + >>> # Fill nulls in specific string columns + >>> df = df.fill_null("missing", subset=["name", "category"]) + + .. rubric:: Notes + + - Only fills nulls in columns where the value can be cast to the column type + - For columns where casting fails, the original column is kept unchanged + - For columns not in subset, the original column is kept unchanged + + + .. py:method:: filter(*predicates: datafusion.expr.Expr) -> DataFrame Return a DataFrame for which ``predicate`` evaluates to ``True``.
diff --git a/_sources/autoapi/datafusion/expr/index.rst.txt b/_sources/autoapi/datafusion/expr/index.rst.txt index 72d4cdc..51caf4b 100644 --- a/_sources/autoapi/datafusion/expr/index.rst.txt +++ b/_sources/autoapi/datafusion/expr/index.rst.txt
@@ -25,14 +25,29 @@ datafusion.expr.Case datafusion.expr.Cast datafusion.expr.Column + datafusion.expr.CopyTo + datafusion.expr.CreateCatalog + datafusion.expr.CreateCatalogSchema + datafusion.expr.CreateExternalTable + datafusion.expr.CreateFunction + datafusion.expr.CreateFunctionBody + datafusion.expr.CreateIndex datafusion.expr.CreateMemoryTable datafusion.expr.CreateView + datafusion.expr.Deallocate + datafusion.expr.DescribeTable datafusion.expr.Distinct + datafusion.expr.DmlStatement + datafusion.expr.DropCatalogSchema + datafusion.expr.DropFunction datafusion.expr.DropTable + datafusion.expr.DropView datafusion.expr.EmptyRelation + datafusion.expr.Execute datafusion.expr.Exists datafusion.expr.Explain datafusion.expr.Extension + datafusion.expr.FileType datafusion.expr.Filter datafusion.expr.GroupingSet datafusion.expr.ILike @@ -54,21 +69,31 @@ datafusion.expr.Literal datafusion.expr.Negative datafusion.expr.Not + datafusion.expr.OperateFunctionArg datafusion.expr.Partitioning datafusion.expr.Placeholder + datafusion.expr.Prepare datafusion.expr.Projection + datafusion.expr.RecursiveQuery datafusion.expr.Repartition datafusion.expr.ScalarSubquery datafusion.expr.ScalarVariable + datafusion.expr.SetVariable datafusion.expr.SimilarTo datafusion.expr.Sort datafusion.expr.Subquery datafusion.expr.SubqueryAlias datafusion.expr.TableScan + datafusion.expr.TransactionAccessMode + datafusion.expr.TransactionConclusion + datafusion.expr.TransactionEnd + datafusion.expr.TransactionIsolationLevel + datafusion.expr.TransactionStart datafusion.expr.TryCast datafusion.expr.Union datafusion.expr.Unnest datafusion.expr.UnnestExpr + datafusion.expr.Values datafusion.expr.WindowExpr @@ -270,10 +295,121 @@ - .. py:method:: alias(name: str) -> Expr + .. py:method:: abs() -> Expr + + Return the absolute value of a given number. + + Returns: + -------- + Expr + A new expression representing the absolute value of the input expression. + + + + .. py:method:: acos() -> Expr + + Returns the arc cosine or inverse cosine of a number. + + Returns: + -------- + Expr + A new expression representing the arc cosine of the input expression. + + + + .. py:method:: acosh() -> Expr + + Returns inverse hyperbolic cosine. + + + + .. py:method:: alias(name: str, metadata: Optional[dict[str, str]] = None) -> Expr Assign a name to the expression. + :param name: The name to assign to the expression. + :param metadata: Optional metadata to attach to the expression. + + :returns: A new expression with the assigned name. + + + + .. py:method:: array_dims() -> Expr + + Returns an array of the array's dimensions. + + + + .. py:method:: array_distinct() -> Expr + + Returns distinct values from the array after removing duplicates. + + + + .. py:method:: array_empty() -> Expr + + Returns a boolean indicating whether the array is empty. + + + + .. py:method:: array_length() -> Expr + + Returns the length of the array. + + + + .. py:method:: array_ndims() -> Expr + + Returns the number of dimensions of the array. + + + + .. py:method:: array_pop_back() -> Expr + + Returns the array without the last element. + + + + .. py:method:: array_pop_front() -> Expr + + Returns the array without the first element. + + + + .. py:method:: arrow_typeof() -> Expr + + Returns the Arrow type of the expression. + + + + .. py:method:: ascii() -> Expr + + Returns the numeric code of the first character of the argument. + + + + .. py:method:: asin() -> Expr + + Returns the arc sine or inverse sine of a number. + + + + .. py:method:: asinh() -> Expr + + Returns inverse hyperbolic sine. + + + + .. py:method:: atan() -> Expr + + Returns inverse tangent of a number. + + + + .. py:method:: atanh() -> Expr + + Returns inverse hyperbolic tangent. + .. py:method:: between(low: Any, high: Any, negated: bool = False) -> Expr @@ -286,18 +422,66 @@ + .. py:method:: bit_length() -> Expr + + Returns the number of bits in the string argument. + + + + .. py:method:: btrim() -> Expr + + Removes all characters, spaces by default, from both sides of a string. + + + .. py:method:: canonical_name() -> str Returns a complete string representation of this expression. + .. py:method:: cardinality() -> Expr + + Returns the total number of elements in the array. + + + .. py:method:: cast(to: pyarrow.DataType[Any] | type[float | int | str | bool]) -> Expr Cast to a new data type. + .. py:method:: cbrt() -> Expr + + Returns the cube root of a number. + + + + .. py:method:: ceil() -> Expr + + Returns the nearest integer greater than or equal to argument. + + + + .. py:method:: char_length() -> Expr + + The number of characters in the ``string``. + + + + .. py:method:: character_length() -> Expr + + Returns the number of characters in the argument. + + + + .. py:method:: chr() -> Expr + + Converts the Unicode code point to a UTF8 character. + + + .. py:method:: column(value: str) -> Expr :staticmethod: @@ -312,6 +496,30 @@ + .. py:method:: cos() -> Expr + + Returns the cosine of the argument. + + + + .. py:method:: cosh() -> Expr + + Returns the hyperbolic cosine of the argument. + + + + .. py:method:: cot() -> Expr + + Returns the cotangent of the argument. + + + + .. py:method:: degrees() -> Expr + + Converts the argument from radians to degrees. + + + .. py:method:: display_name() -> str Returns the name of this expression as it should appear in a schema. @@ -330,6 +538,24 @@ + .. py:method:: empty() -> Expr + + This is an alias for :py:func:`array_empty`. + + + + .. py:method:: exp() -> Expr + + Returns the exponential of the argument. + + + + .. py:method:: factorial() -> Expr + + Returns the factorial of the argument. + + + .. py:method:: fill_nan(value: Any | Expr | None = None) -> Expr Fill NaN values with a provided value. @@ -352,6 +578,33 @@ + .. py:method:: flatten() -> Expr + + Flattens an array of arrays into a single array. + + + + .. py:method:: floor() -> Expr + + Returns the nearest integer less than or equal to the argument. + + + + .. py:method:: from_unixtime() -> Expr + + Converts an integer to RFC3339 timestamp format string. + + + + .. py:method:: initcap() -> Expr + + Set the initial letter of each word to capital. + + Converts the first letter of each word in ``string`` to uppercase and the + remaining characters to lowercase. + + + .. py:method:: is_not_null() -> Expr Returns ``True`` if this expression is not null. @@ -364,6 +617,56 @@ + .. py:method:: isnan() -> Expr + + Returns true if a given number is +NaN or -NaN otherwise returns false. + + + + .. py:method:: iszero() -> Expr + + Returns true if a given number is +0.0 or -0.0 otherwise returns false. + + + + .. py:method:: length() -> Expr + + The number of characters in the ``string``. + + + + .. py:method:: list_dims() -> Expr + + Returns an array of the array's dimensions. + + This is an alias for :py:func:`array_dims`. + + + + .. py:method:: list_distinct() -> Expr + + Returns distinct values from the array after removing duplicates. + + This is an alias for :py:func:`array_distinct`. + + + + .. py:method:: list_length() -> Expr + + Returns the length of the array. + + This is an alias for :py:func:`array_length`. + + + + .. py:method:: list_ndims() -> Expr + + Returns the number of dimensions of the array. + + This is an alias for :py:func:`array_ndims`. + + + .. py:method:: literal(value: Any) -> Expr :staticmethod: @@ -374,6 +677,42 @@ + .. py:method:: ln() -> Expr + + Returns the natural logarithm (base e) of the argument. + + + + .. py:method:: log10() -> Expr + + Base 10 logarithm of the argument. + + + + .. py:method:: log2() -> Expr + + Base 2 logarithm of the argument. + + + + .. py:method:: lower() -> Expr + + Converts a string to lowercase. + + + + .. py:method:: ltrim() -> Expr + + Removes all characters, spaces by default, from the beginning of a string. + + + + .. py:method:: md5() -> Expr + + Computes an MD5 128-bit checksum for a string expression. + + + .. py:method:: null_treatment(null_treatment: datafusion.common.NullTreatment) -> ExprFuncBuilder Set the treatment for ``null`` values for a window or aggregate function. @@ -384,6 +723,12 @@ + .. py:method:: octet_length() -> Expr + + Returns the number of bytes of a string. + + + .. py:method:: order_by(*exprs: Expr | SortExpr) -> ExprFuncBuilder Set the ordering for a window or aggregate function. @@ -426,6 +771,18 @@ + .. py:method:: radians() -> Expr + + Converts the argument from degrees to radians. + + + + .. py:method:: reverse() -> Expr + + Reverse the string argument. + + + .. py:method:: rex_call_operands() -> list[Expr] Return the operands of the expression based on it's variant type. @@ -453,6 +810,12 @@ + .. py:method:: rtrim() -> Expr + + Removes all characters, spaces by default, from the end of a string. + + + .. py:method:: schema_name() -> str Returns the name of this expression as it should appear in a schema. @@ -461,6 +824,48 @@ + .. py:method:: sha224() -> Expr + + Computes the SHA-224 hash of a binary string. + + + + .. py:method:: sha256() -> Expr + + Computes the SHA-256 hash of a binary string. + + + + .. py:method:: sha384() -> Expr + + Computes the SHA-384 hash of a binary string. + + + + .. py:method:: sha512() -> Expr + + Computes the SHA-512 hash of a binary string. + + + + .. py:method:: signum() -> Expr + + Returns the sign of the argument (-1, 0, +1). + + + + .. py:method:: sin() -> Expr + + Returns the sine of the argument. + + + + .. py:method:: sinh() -> Expr + + Returns the hyperbolic sine of the argument. + + + .. py:method:: sort(ascending: bool = True, nulls_first: bool = True) -> SortExpr Creates a sort :py:class:`Expr` from an existing :py:class:`Expr`. @@ -470,6 +875,12 @@ + .. py:method:: sqrt() -> Expr + + Returns the square root of the argument. + + + .. py:method:: string_literal(value: str) -> Expr :staticmethod: @@ -485,12 +896,36 @@ + .. py:method:: tan() -> Expr + + Returns the tangent of the argument. + + + + .. py:method:: tanh() -> Expr + + Returns the hyperbolic tangent of the argument. + + + + .. py:method:: to_hex() -> Expr + + Converts an integer to a hexadecimal string. + + + .. py:method:: to_variant() -> Any Convert this expression into a python object if possible. + .. py:method:: trim() -> Expr + + Removes all characters, spaces by default, from both sides of a string. + + + .. py:method:: types() -> datafusion.common.DataTypeMap Return the ``DataTypeMap``. @@ -500,6 +935,12 @@ + .. py:method:: upper() -> Expr + + Converts a string to uppercase. + + + .. py:method:: variant_name() -> str Returns the name of the Expr variant. @@ -708,22 +1149,52 @@ .. py:data:: Column +.. py:data:: CopyTo + +.. py:data:: CreateCatalog + +.. py:data:: CreateCatalogSchema + +.. py:data:: CreateExternalTable + +.. py:data:: CreateFunction + +.. py:data:: CreateFunctionBody + +.. py:data:: CreateIndex + .. py:data:: CreateMemoryTable .. py:data:: CreateView +.. py:data:: Deallocate + +.. py:data:: DescribeTable + .. py:data:: Distinct +.. py:data:: DmlStatement + +.. py:data:: DropCatalogSchema + +.. py:data:: DropFunction + .. py:data:: DropTable +.. py:data:: DropView + .. py:data:: EmptyRelation +.. py:data:: Execute + .. py:data:: Exists .. py:data:: Explain .. py:data:: Extension +.. py:data:: FileType + .. py:data:: Filter .. py:data:: GroupingSet @@ -766,18 +1237,26 @@ .. py:data:: Not +.. py:data:: OperateFunctionArg + .. py:data:: Partitioning .. py:data:: Placeholder +.. py:data:: Prepare + .. py:data:: Projection +.. py:data:: RecursiveQuery + .. py:data:: Repartition .. py:data:: ScalarSubquery .. py:data:: ScalarVariable +.. py:data:: SetVariable + .. py:data:: SimilarTo .. py:data:: Sort @@ -788,6 +1267,16 @@ .. py:data:: TableScan +.. py:data:: TransactionAccessMode + +.. py:data:: TransactionConclusion + +.. py:data:: TransactionEnd + +.. py:data:: TransactionIsolationLevel + +.. py:data:: TransactionStart + .. py:data:: TryCast .. py:data:: Union @@ -796,5 +1285,7 @@ .. py:data:: UnnestExpr +.. py:data:: Values + .. py:data:: WindowExpr
diff --git a/_sources/autoapi/datafusion/functions/index.rst.txt b/_sources/autoapi/datafusion/functions/index.rst.txt index 21fa1d2..3b5f3b4 100644 --- a/_sources/autoapi/datafusion/functions/index.rst.txt +++ b/_sources/autoapi/datafusion/functions/index.rst.txt
@@ -285,9 +285,15 @@ Returns inverse hyperbolic cosine. -.. py:function:: alias(expr: datafusion.expr.Expr, name: str) -> datafusion.expr.Expr +.. py:function:: alias(expr: datafusion.expr.Expr, name: str, metadata: Optional[dict[str, str]] = None) -> datafusion.expr.Expr - Creates an alias expression. + Creates an alias expression with an optional metadata dictionary. + + :param expr: The expression to alias + :param name: The alias name + :param metadata: Optional metadata to attach to the column + + :returns: An expression with the given alias .. py:function:: approx_distinct(expression: datafusion.expr.Expr, filter: Optional[datafusion.expr.Expr] = None) -> datafusion.expr.Expr
diff --git a/_sources/autoapi/datafusion/html_formatter/index.rst.txt b/_sources/autoapi/datafusion/html_formatter/index.rst.txt new file mode 100644 index 0000000..b00cced --- /dev/null +++ b/_sources/autoapi/datafusion/html_formatter/index.rst.txt
@@ -0,0 +1,508 @@ +datafusion.html_formatter +========================= + +.. py:module:: datafusion.html_formatter + +.. autoapi-nested-parse:: + + HTML formatting utilities for DataFusion DataFrames. + + + +Classes +------- + +.. autoapisummary:: + + datafusion.html_formatter.CellFormatter + datafusion.html_formatter.DataFrameHtmlFormatter + datafusion.html_formatter.DefaultStyleProvider + datafusion.html_formatter.FormatterManager + datafusion.html_formatter.StyleProvider + + +Functions +--------- + +.. autoapisummary:: + + datafusion.html_formatter._refresh_formatter_reference + datafusion.html_formatter._validate_bool + datafusion.html_formatter._validate_positive_int + datafusion.html_formatter.configure_formatter + datafusion.html_formatter.get_formatter + datafusion.html_formatter.reset_formatter + datafusion.html_formatter.reset_styles_loaded_state + datafusion.html_formatter.set_formatter + + +Module Contents +--------------- + +.. py:class:: CellFormatter + + Bases: :py:obj:`Protocol` + + + Protocol for cell value formatters. + + + .. py:method:: __call__(value: Any) -> str + + Format a cell value to string representation. + + + +.. py:class:: DataFrameHtmlFormatter(max_cell_length: int = 25, max_width: int = 1000, max_height: int = 300, max_memory_bytes: int = 2 * 1024 * 1024, min_rows_display: int = 20, repr_rows: int = 10, enable_cell_expansion: bool = True, custom_css: Optional[str] = None, show_truncation_message: bool = True, style_provider: Optional[StyleProvider] = None, use_shared_styles: bool = True) + + Configurable HTML formatter for DataFusion DataFrames. + + This class handles the HTML rendering of DataFrames for display in + Jupyter notebooks and other rich display contexts. + + This class supports extension through composition. Key extension points: + - Provide a custom StyleProvider for styling cells and headers + - Register custom formatters for specific types + - Provide custom cell builders for specialized cell rendering + + :param max_cell_length: Maximum characters to display in a cell before truncation + :param max_width: Maximum width of the HTML table in pixels + :param max_height: Maximum height of the HTML table in pixels + :param max_memory_bytes: Maximum memory in bytes for rendered data (default: 2MB) + :param min_rows_display: Minimum number of rows to display + :param repr_rows: Default number of rows to display in repr output + :param enable_cell_expansion: Whether to add expand/collapse buttons for long cell + values + :param custom_css: Additional CSS to include in the HTML output + :param show_truncation_message: Whether to display a message when data is truncated + :param style_provider: Custom provider for cell and header styles + :param use_shared_styles: Whether to load styles and scripts only once per notebook + session + + Initialize the HTML formatter. + + :param max_cell_length: Maximum length of cell content before truncation. + :type max_cell_length: int, default 25 + :param max_width: Maximum width of the displayed table in pixels. + :type max_width: int, default 1000 + :param max_height: Maximum height of the displayed table in pixels. + :type max_height: int, default 300 + :param max_memory_bytes: Maximum memory in bytes for rendered data. + :type max_memory_bytes: int, default 2097152 (2MB) + :param min_rows_display: Minimum number of rows to display. + :type min_rows_display: int, default 20 + :param repr_rows: Default number of rows to display in repr output. + :type repr_rows: int, default 10 + :param enable_cell_expansion: Whether to allow cells to expand when clicked. + :type enable_cell_expansion: bool, default True + :param custom_css: Custom CSS to apply to the HTML table. + :type custom_css: str, optional + :param show_truncation_message: Whether to show a message indicating that content has been truncated. + :type show_truncation_message: bool, default True + :param style_provider: Provider of CSS styles for the HTML table. If None, DefaultStyleProvider + is used. + :type style_provider: StyleProvider, optional + :param use_shared_styles: Whether to use shared styles across multiple tables. + :type use_shared_styles: bool, default True + :param Raises: + :param ------: + :param ValueError: If max_cell_length, max_width, max_height, max_memory_bytes, + min_rows_display, or repr_rows is not a positive integer. + :param TypeError: If enable_cell_expansion, show_truncation_message, or use_shared_styles is + not a boolean, + or if custom_css is provided but is not a string, + or if style_provider is provided but does not implement the StyleProvider + protocol. + + + .. py:method:: _build_expandable_cell(formatted_value: str, row_count: int, col_idx: int, table_uuid: str) -> str + + Build an expandable cell for long content. + + + + .. py:method:: _build_html_footer(has_more: bool) -> list[str] + + Build the HTML footer with JavaScript and messages. + + + + .. py:method:: _build_html_header() -> list[str] + + Build the HTML header with CSS styles. + + + + .. py:method:: _build_regular_cell(formatted_value: str) -> str + + Build a regular table cell. + + + + .. py:method:: _build_table_body(batches: list, table_uuid: str) -> list[str] + + Build the HTML table body with data rows. + + + + .. py:method:: _build_table_container_start() -> list[str] + + Build the opening tags for the table container. + + + + .. py:method:: _build_table_header(schema: Any) -> list[str] + + Build the HTML table header with column names. + + + + .. py:method:: _format_cell_value(value: Any) -> str + + Format a cell value for display. + + Uses registered type formatters if available. + + :param value: The cell value to format + + :returns: Formatted cell value as string + + + + .. py:method:: _get_cell_value(column: Any, row_idx: int) -> Any + + Extract a cell value from a column. + + :param column: Arrow array + :param row_idx: Row index + + :returns: The raw cell value + + + + .. py:method:: _get_default_css() -> str + + Get default CSS styles for the HTML table. + + + + .. py:method:: _get_javascript() -> str + + Get JavaScript code for interactive elements. + + + + .. py:method:: format_html(batches: list, schema: Any, has_more: bool = False, table_uuid: str | None = None) -> str + + Format record batches as HTML. + + This method is used by DataFrame's _repr_html_ implementation and can be + called directly when custom HTML rendering is needed. + + :param batches: List of Arrow RecordBatch objects + :param schema: Arrow Schema object + :param has_more: Whether there are more batches not shown + :param table_uuid: Unique ID for the table, used for JavaScript interactions + + :returns: HTML string representation of the data + + :raises TypeError: If schema is invalid and no batches are provided + + + + .. py:method:: is_styles_loaded() -> bool + :classmethod: + + + Check if HTML styles have been loaded in the current session. + + This method is primarily intended for debugging UI rendering issues + related to style loading. + + :returns: True if styles have been loaded, False otherwise + + .. rubric:: Example + + >>> from datafusion.html_formatter import DataFrameHtmlFormatter + >>> DataFrameHtmlFormatter.is_styles_loaded() + False + + + + .. py:method:: register_formatter(type_class: type, formatter: CellFormatter) -> None + + Register a custom formatter for a specific data type. + + :param type_class: The type to register a formatter for + :param formatter: Function that takes a value of the given type and returns + a formatted string + + + + .. py:method:: set_custom_cell_builder(builder: Callable[[Any, int, int, str], str]) -> None + + Set a custom cell builder function. + + :param builder: Function that takes (value, row, col, table_id) and returns HTML + + + + .. py:method:: set_custom_header_builder(builder: Callable[[Any], str]) -> None + + Set a custom header builder function. + + :param builder: Function that takes a field and returns HTML + + + + .. py:attribute:: _custom_cell_builder + :type: Optional[Callable[[Any, int, int, str], str]] + :value: None + + + + .. py:attribute:: _custom_header_builder + :type: Optional[Callable[[Any], str]] + :value: None + + + + .. py:attribute:: _styles_loaded + :value: False + + + + .. py:attribute:: _type_formatters + :type: dict[type, CellFormatter] + + + .. py:attribute:: custom_css + :value: None + + + + .. py:attribute:: enable_cell_expansion + :value: True + + + + .. py:attribute:: max_cell_length + :value: 25 + + + + .. py:attribute:: max_height + :value: 300 + + + + .. py:attribute:: max_memory_bytes + :value: 2097152 + + + + .. py:attribute:: max_width + :value: 1000 + + + + .. py:attribute:: min_rows_display + :value: 20 + + + + .. py:attribute:: repr_rows + :value: 10 + + + + .. py:attribute:: show_truncation_message + :value: True + + + + .. py:attribute:: style_provider + + + .. py:attribute:: use_shared_styles + :value: True + + + +.. py:class:: DefaultStyleProvider + + Default implementation of StyleProvider. + + + .. py:method:: get_cell_style() -> str + + Get the CSS style for table cells. + + :returns: CSS style string + + + + .. py:method:: get_header_style() -> str + + Get the CSS style for header cells. + + :returns: CSS style string + + + +.. py:class:: FormatterManager + + Manager class for the global DataFrame HTML formatter instance. + + + .. py:method:: get_formatter() -> DataFrameHtmlFormatter + :classmethod: + + + Get the current global DataFrame HTML formatter. + + :returns: The global HTML formatter instance + + + + .. py:method:: set_formatter(formatter: DataFrameHtmlFormatter) -> None + :classmethod: + + + Set the global DataFrame HTML formatter. + + :param formatter: The formatter instance to use globally + + + + .. py:attribute:: _default_formatter + :type: DataFrameHtmlFormatter + + +.. py:class:: StyleProvider + + Bases: :py:obj:`Protocol` + + + Protocol for HTML style providers. + + + .. py:method:: get_cell_style() -> str + + Get the CSS style for table cells. + + + + .. py:method:: get_header_style() -> str + + Get the CSS style for header cells. + + + +.. py:function:: _refresh_formatter_reference() -> None + + Refresh formatter reference in any modules using it. + + This helps ensure that changes to the formatter are reflected in existing + DataFrames that might be caching the formatter reference. + + +.. py:function:: _validate_bool(value: Any, param_name: str) -> None + + Validate that a parameter is a boolean. + + :param value: The value to validate + :param param_name: Name of the parameter (used in error message) + + :raises TypeError: If the value is not a boolean + + +.. py:function:: _validate_positive_int(value: Any, param_name: str) -> None + + Validate that a parameter is a positive integer. + + :param value: The value to validate + :param param_name: Name of the parameter (used in error message) + + :raises ValueError: If the value is not a positive integer + + +.. py:function:: configure_formatter(**kwargs: Any) -> None + + Configure the global DataFrame HTML formatter. + + This function creates a new formatter with the provided configuration + and sets it as the global formatter for all DataFrames. + + :param \*\*kwargs: Formatter configuration parameters like max_cell_length, + max_width, max_height, enable_cell_expansion, etc. + + :raises ValueError: If any invalid parameters are provided + + .. rubric:: Example + + >>> from datafusion.html_formatter import configure_formatter + >>> configure_formatter( + ... max_cell_length=50, + ... max_height=500, + ... enable_cell_expansion=True, + ... use_shared_styles=True + ... ) + + +.. py:function:: get_formatter() -> DataFrameHtmlFormatter + + Get the current global DataFrame HTML formatter. + + This function is used by the DataFrame._repr_html_ implementation to access + the shared formatter instance. It can also be used directly when custom + HTML rendering is needed. + + :returns: The global HTML formatter instance + + .. rubric:: Example + + >>> from datafusion.html_formatter import get_formatter + >>> formatter = get_formatter() + >>> formatter.max_cell_length = 50 # Increase cell length + + +.. py:function:: reset_formatter() -> None + + Reset the global DataFrame HTML formatter to default settings. + + This function creates a new formatter with default configuration + and sets it as the global formatter for all DataFrames. + + .. rubric:: Example + + >>> from datafusion.html_formatter import reset_formatter + >>> reset_formatter() # Reset formatter to default settings + + +.. py:function:: reset_styles_loaded_state() -> None + + Reset the styles loaded state to force reloading of styles. + + This can be useful when switching between notebook sessions or + when styles need to be refreshed. + + .. rubric:: Example + + >>> from datafusion.html_formatter import reset_styles_loaded_state + >>> reset_styles_loaded_state() # Force styles to reload in next render + + +.. py:function:: set_formatter(formatter: DataFrameHtmlFormatter) -> None + + Set the global DataFrame HTML formatter. + + :param formatter: The formatter instance to use globally + + .. rubric:: Example + + >>> from datafusion.html_formatter import get_formatter, set_formatter + >>> custom_formatter = DataFrameHtmlFormatter(max_cell_length=100) + >>> set_formatter(custom_formatter) + +
diff --git a/_sources/autoapi/datafusion/index.rst.txt b/_sources/autoapi/datafusion/index.rst.txt index 84313ec..07c99bf 100644 --- a/_sources/autoapi/datafusion/index.rst.txt +++ b/_sources/autoapi/datafusion/index.rst.txt
@@ -19,10 +19,12 @@ :maxdepth: 1 /autoapi/datafusion/catalog/index + /autoapi/datafusion/col/index /autoapi/datafusion/context/index /autoapi/datafusion/dataframe/index /autoapi/datafusion/expr/index /autoapi/datafusion/functions/index + /autoapi/datafusion/html_formatter/index /autoapi/datafusion/input/index /autoapi/datafusion/io/index /autoapi/datafusion/object_store/index @@ -30,6 +32,8 @@ /autoapi/datafusion/record_batch/index /autoapi/datafusion/substrait/index /autoapi/datafusion/udf/index + /autoapi/datafusion/unparser/index + /autoapi/datafusion/user_defined/index Attributes @@ -38,8 +42,11 @@ .. autoapisummary:: datafusion.DFSchema + datafusion.col + datafusion.column datafusion.udaf datafusion.udf + datafusion.udtf datafusion.udwf @@ -62,6 +69,7 @@ datafusion.ScalarUDF datafusion.SessionConfig datafusion.Table + datafusion.TableFunction datafusion.WindowFrame datafusion.WindowUDF @@ -71,8 +79,7 @@ .. autoapisummary:: - datafusion.col - datafusion.column + datafusion.configure_formatter datafusion.lit datafusion.literal datafusion.read_avro @@ -150,24 +157,22 @@ Create a new User-Defined Aggregate Function (UDAF). - This class allows you to define an **aggregate function** that can be used in + This class allows you to define an aggregate function that can be used in data aggregation or window function calls. Usage: - - **As a function**: Call `udaf(accum, input_types, return_type, state_type, - volatility, name)`. - - **As a decorator**: Use `@udaf(input_types, return_type, state_type, - volatility, name)`. - When using `udaf` as a decorator, **do not pass `accum` explicitly**. + - As a function: ``udaf(accum, input_types, return_type, state_type, volatility, name)``. + - As a decorator: ``@udaf(input_types, return_type, state_type, volatility, name)``. + When using ``udaf`` as a decorator, do not pass ``accum`` explicitly. - **Function example:** + Function example: - If your `:py:class:Accumulator` can be instantiated with no arguments, you - can simply pass it's type as `accum`. If you need to pass additional - arguments to it's constructor, you can define a lambda or a factory method. - During runtime the `:py:class:Accumulator` will be constructed for every - instance in which this UDAF is used. The following examples are all valid. - ``` + If your :py:class:`Accumulator` can be instantiated with no arguments, you + can simply pass it's type as `accum`. If you need to pass additional + arguments to it's constructor, you can define a lambda or a factory method. + During runtime the :py:class:`Accumulator` will be constructed for every + instance in which this UDAF is used. The following examples are all valid:: + import pyarrow as pa import pyarrow.compute as pc @@ -196,17 +201,15 @@ "immutable") udaf3 = udaf(lambda: Summarize(20.0), pa.float64(), pa.float64(), [pa.float64()], "immutable") - ``` - **Decorator example:** - ``` + Decorator example::: + @udaf(pa.float64(), pa.float64(), [pa.float64()], "immutable") def udf4() -> Summarize: return Summarize(10.0) - ``` - :param accum: The accumulator python function. **Only needed when calling as a - function. Skip this argument when using `udaf` as a decorator.** + :param accum: The accumulator python function. Only needed when calling as a + function. Skip this argument when using ``udaf`` as a decorator. :param input_types: The data types of the arguments to ``accum``. :param return_type: The data type of the return value. :param state_type: The data types of the intermediate accumulation. @@ -465,10 +468,121 @@ - .. py:method:: alias(name: str) -> Expr + .. py:method:: abs() -> Expr + + Return the absolute value of a given number. + + Returns: + -------- + Expr + A new expression representing the absolute value of the input expression. + + + + .. py:method:: acos() -> Expr + + Returns the arc cosine or inverse cosine of a number. + + Returns: + -------- + Expr + A new expression representing the arc cosine of the input expression. + + + + .. py:method:: acosh() -> Expr + + Returns inverse hyperbolic cosine. + + + + .. py:method:: alias(name: str, metadata: Optional[dict[str, str]] = None) -> Expr Assign a name to the expression. + :param name: The name to assign to the expression. + :param metadata: Optional metadata to attach to the expression. + + :returns: A new expression with the assigned name. + + + + .. py:method:: array_dims() -> Expr + + Returns an array of the array's dimensions. + + + + .. py:method:: array_distinct() -> Expr + + Returns distinct values from the array after removing duplicates. + + + + .. py:method:: array_empty() -> Expr + + Returns a boolean indicating whether the array is empty. + + + + .. py:method:: array_length() -> Expr + + Returns the length of the array. + + + + .. py:method:: array_ndims() -> Expr + + Returns the number of dimensions of the array. + + + + .. py:method:: array_pop_back() -> Expr + + Returns the array without the last element. + + + + .. py:method:: array_pop_front() -> Expr + + Returns the array without the first element. + + + + .. py:method:: arrow_typeof() -> Expr + + Returns the Arrow type of the expression. + + + + .. py:method:: ascii() -> Expr + + Returns the numeric code of the first character of the argument. + + + + .. py:method:: asin() -> Expr + + Returns the arc sine or inverse sine of a number. + + + + .. py:method:: asinh() -> Expr + + Returns inverse hyperbolic sine. + + + + .. py:method:: atan() -> Expr + + Returns inverse tangent of a number. + + + + .. py:method:: atanh() -> Expr + + Returns inverse hyperbolic tangent. + .. py:method:: between(low: Any, high: Any, negated: bool = False) -> Expr @@ -481,18 +595,66 @@ + .. py:method:: bit_length() -> Expr + + Returns the number of bits in the string argument. + + + + .. py:method:: btrim() -> Expr + + Removes all characters, spaces by default, from both sides of a string. + + + .. py:method:: canonical_name() -> str Returns a complete string representation of this expression. + .. py:method:: cardinality() -> Expr + + Returns the total number of elements in the array. + + + .. py:method:: cast(to: pyarrow.DataType[Any] | type[float | int | str | bool]) -> Expr Cast to a new data type. + .. py:method:: cbrt() -> Expr + + Returns the cube root of a number. + + + + .. py:method:: ceil() -> Expr + + Returns the nearest integer greater than or equal to argument. + + + + .. py:method:: char_length() -> Expr + + The number of characters in the ``string``. + + + + .. py:method:: character_length() -> Expr + + Returns the number of characters in the argument. + + + + .. py:method:: chr() -> Expr + + Converts the Unicode code point to a UTF8 character. + + + .. py:method:: column(value: str) -> Expr :staticmethod: @@ -507,6 +669,30 @@ + .. py:method:: cos() -> Expr + + Returns the cosine of the argument. + + + + .. py:method:: cosh() -> Expr + + Returns the hyperbolic cosine of the argument. + + + + .. py:method:: cot() -> Expr + + Returns the cotangent of the argument. + + + + .. py:method:: degrees() -> Expr + + Converts the argument from radians to degrees. + + + .. py:method:: display_name() -> str Returns the name of this expression as it should appear in a schema. @@ -525,6 +711,24 @@ + .. py:method:: empty() -> Expr + + This is an alias for :py:func:`array_empty`. + + + + .. py:method:: exp() -> Expr + + Returns the exponential of the argument. + + + + .. py:method:: factorial() -> Expr + + Returns the factorial of the argument. + + + .. py:method:: fill_nan(value: Any | Expr | None = None) -> Expr Fill NaN values with a provided value. @@ -547,6 +751,33 @@ + .. py:method:: flatten() -> Expr + + Flattens an array of arrays into a single array. + + + + .. py:method:: floor() -> Expr + + Returns the nearest integer less than or equal to the argument. + + + + .. py:method:: from_unixtime() -> Expr + + Converts an integer to RFC3339 timestamp format string. + + + + .. py:method:: initcap() -> Expr + + Set the initial letter of each word to capital. + + Converts the first letter of each word in ``string`` to uppercase and the + remaining characters to lowercase. + + + .. py:method:: is_not_null() -> Expr Returns ``True`` if this expression is not null. @@ -559,6 +790,56 @@ + .. py:method:: isnan() -> Expr + + Returns true if a given number is +NaN or -NaN otherwise returns false. + + + + .. py:method:: iszero() -> Expr + + Returns true if a given number is +0.0 or -0.0 otherwise returns false. + + + + .. py:method:: length() -> Expr + + The number of characters in the ``string``. + + + + .. py:method:: list_dims() -> Expr + + Returns an array of the array's dimensions. + + This is an alias for :py:func:`array_dims`. + + + + .. py:method:: list_distinct() -> Expr + + Returns distinct values from the array after removing duplicates. + + This is an alias for :py:func:`array_distinct`. + + + + .. py:method:: list_length() -> Expr + + Returns the length of the array. + + This is an alias for :py:func:`array_length`. + + + + .. py:method:: list_ndims() -> Expr + + Returns the number of dimensions of the array. + + This is an alias for :py:func:`array_ndims`. + + + .. py:method:: literal(value: Any) -> Expr :staticmethod: @@ -569,6 +850,42 @@ + .. py:method:: ln() -> Expr + + Returns the natural logarithm (base e) of the argument. + + + + .. py:method:: log10() -> Expr + + Base 10 logarithm of the argument. + + + + .. py:method:: log2() -> Expr + + Base 2 logarithm of the argument. + + + + .. py:method:: lower() -> Expr + + Converts a string to lowercase. + + + + .. py:method:: ltrim() -> Expr + + Removes all characters, spaces by default, from the beginning of a string. + + + + .. py:method:: md5() -> Expr + + Computes an MD5 128-bit checksum for a string expression. + + + .. py:method:: null_treatment(null_treatment: datafusion.common.NullTreatment) -> ExprFuncBuilder Set the treatment for ``null`` values for a window or aggregate function. @@ -579,6 +896,12 @@ + .. py:method:: octet_length() -> Expr + + Returns the number of bytes of a string. + + + .. py:method:: order_by(*exprs: Expr | SortExpr) -> ExprFuncBuilder Set the ordering for a window or aggregate function. @@ -621,6 +944,18 @@ + .. py:method:: radians() -> Expr + + Converts the argument from degrees to radians. + + + + .. py:method:: reverse() -> Expr + + Reverse the string argument. + + + .. py:method:: rex_call_operands() -> list[Expr] Return the operands of the expression based on it's variant type. @@ -648,6 +983,12 @@ + .. py:method:: rtrim() -> Expr + + Removes all characters, spaces by default, from the end of a string. + + + .. py:method:: schema_name() -> str Returns the name of this expression as it should appear in a schema. @@ -656,6 +997,48 @@ + .. py:method:: sha224() -> Expr + + Computes the SHA-224 hash of a binary string. + + + + .. py:method:: sha256() -> Expr + + Computes the SHA-256 hash of a binary string. + + + + .. py:method:: sha384() -> Expr + + Computes the SHA-384 hash of a binary string. + + + + .. py:method:: sha512() -> Expr + + Computes the SHA-512 hash of a binary string. + + + + .. py:method:: signum() -> Expr + + Returns the sign of the argument (-1, 0, +1). + + + + .. py:method:: sin() -> Expr + + Returns the sine of the argument. + + + + .. py:method:: sinh() -> Expr + + Returns the hyperbolic sine of the argument. + + + .. py:method:: sort(ascending: bool = True, nulls_first: bool = True) -> SortExpr Creates a sort :py:class:`Expr` from an existing :py:class:`Expr`. @@ -665,6 +1048,12 @@ + .. py:method:: sqrt() -> Expr + + Returns the square root of the argument. + + + .. py:method:: string_literal(value: str) -> Expr :staticmethod: @@ -680,12 +1069,36 @@ + .. py:method:: tan() -> Expr + + Returns the tangent of the argument. + + + + .. py:method:: tanh() -> Expr + + Returns the hyperbolic tangent of the argument. + + + + .. py:method:: to_hex() -> Expr + + Converts an integer to a hexadecimal string. + + + .. py:method:: to_variant() -> Any Convert this expression into a python object if possible. + .. py:method:: trim() -> Expr + + Removes all characters, spaces by default, from both sides of a string. + + + .. py:method:: types() -> datafusion.common.DataTypeMap Return the ``DataTypeMap``. @@ -695,6 +1108,12 @@ + .. py:method:: upper() -> Expr + + Converts a string to uppercase. + + + .. py:method:: variant_name() -> str Returns the name of the Expr variant. @@ -1082,19 +1501,18 @@ Create a new User-Defined Function (UDF). - This class can be used both as a **function** and as a **decorator**. + This class can be used both as either a function or a decorator. Usage: - - **As a function**: Call `udf(func, input_types, return_type, volatility, - name)`. - - **As a decorator**: Use `@udf(input_types, return_type, volatility, - name)`. In this case, do **not** pass `func` explicitly. + - As a function: ``udf(func, input_types, return_type, volatility, name)``. + - As a decorator: ``@udf(input_types, return_type, volatility, name)``. + When used a decorator, do **not** pass ``func`` explicitly. - :param func: **Only needed when calling as a function.** - Skip this argument when using `udf` as a decorator. + :param func: Only needed when calling as a function. + Skip this argument when using ``udf`` as a decorator. :type func: Callable, optional :param input_types: The data types of the arguments - to `func`. This list must be of the same length as the number of + to ``func``. This list must be of the same length as the number of arguments. :type input_types: list[pa.DataType] :param return_type: The data type of the return value from the function. @@ -1107,22 +1525,18 @@ :returns: A user-defined function that can be used in SQL expressions, data aggregation, or window function calls. - .. rubric:: Example + Example: Using ``udf`` as a function:: - **Using `udf` as a function:** - ``` - def double_func(x): - return x * 2 - double_udf = udf(double_func, [pa.int32()], pa.int32(), - "volatile", "double_it") - ``` + def double_func(x): + return x * 2 + double_udf = udf(double_func, [pa.int32()], pa.int32(), + "volatile", "double_it") - **Using `udf` as a decorator:** - ``` - @udf([pa.int32()], pa.int32(), "volatile", "double_it") - def double_udf(x): - return x * 2 - ``` + Example: Using ``udf`` as a decorator:: + + @udf([pa.int32()], pa.int32(), "volatile", "double_it") + def double_udf(x): + return x * 2 @@ -1309,6 +1723,59 @@ .. py:attribute:: table +.. py:class:: TableFunction(name: str, func: Callable[[], any]) + + Class for performing user-defined table functions (UDTF). + + Table functions generate new table providers based on the + input expressions. + + Instantiate a user-defined table function (UDTF). + + See :py:func:`udtf` for a convenience function and argument + descriptions. + + + .. py:method:: __call__(*args: datafusion.expr.Expr) -> Any + + Execute the UDTF and return a table provider. + + + + .. py:method:: __repr__() -> str + + User printable representation. + + + + .. py:method:: _create_table_udf(func: Callable[Ellipsis, Any], name: str) -> TableFunction + :staticmethod: + + + Create a TableFunction instance from function arguments. + + + + .. py:method:: _create_table_udf_decorator(name: Optional[str] = None) -> Callable[[Callable[[], WindowEvaluator]], Callable[Ellipsis, datafusion.expr.Expr]] + :staticmethod: + + + Create a decorator for a WindowUDF. + + + + .. py:method:: udtf(name: str) -> Callable[Ellipsis, Any] + udtf(func: Callable[[], Any], name: str) -> TableFunction + :staticmethod: + + + Create a new User-Defined Table Function (UDTF). + + + + .. py:attribute:: _udtf + + .. py:class:: WindowFrame(units: str, start_bound: Optional[Any], end_bound: Optional[Any]) Defines a window frame for performing window operations. @@ -1406,17 +1873,15 @@ Create a new User-Defined Window Function (UDWF). - This class can be used both as a **function** and as a **decorator**. + This class can be used both as either a function or a decorator. Usage: - - **As a function**: Call `udwf(func, input_types, return_type, volatility, - name)`. - - **As a decorator**: Use `@udwf(input_types, return_type, volatility, - name)`. When using `udwf` as a decorator, **do not pass `func` - explicitly**. + - As a function: ``udwf(func, input_types, return_type, volatility, name)``. + - As a decorator: ``@udwf(input_types, return_type, volatility, name)``. + When using ``udwf`` as a decorator, do not pass ``func`` explicitly. - **Function example:** - ``` + Function example:: + import pyarrow as pa class BiasedNumbers(WindowEvaluator): @@ -1434,17 +1899,15 @@ udwf2 = udwf(bias_10, pa.int64(), pa.int64(), "immutable") udwf3 = udwf(lambda: BiasedNumbers(20), pa.int64(), pa.int64(), "immutable") - ``` - **Decorator example:** - ``` + Decorator example:: + @udwf(pa.int64(), pa.int64(), "immutable") def biased_numbers() -> BiasedNumbers: return BiasedNumbers(10) - ``` - :param func: **Only needed when calling as a function. Skip this argument when - using `udwf` as a decorator.** + :param func: Only needed when calling as a function. Skip this argument when + using ``udwf`` as a decorator. :param input_types: The data types of the arguments. :param return_type: The data type of the return value. :param volatility: See :py:class:`Volatility` for allowed values. @@ -1457,14 +1920,27 @@ .. py:attribute:: _udwf -.. py:function:: col(value: str) -> expr.Expr +.. py:function:: configure_formatter(**kwargs: Any) -> None - Create a column expression. + Configure the global DataFrame HTML formatter. + This function creates a new formatter with the provided configuration + and sets it as the global formatter for all DataFrames. -.. py:function:: column(value: str) -> expr.Expr + :param \*\*kwargs: Formatter configuration parameters like max_cell_length, + max_width, max_height, enable_cell_expansion, etc. - Create a column expression. + :raises ValueError: If any invalid parameters are provided + + .. rubric:: Example + + >>> from datafusion.html_formatter import configure_formatter + >>> configure_formatter( + ... max_cell_length=50, + ... max_height=500, + ... enable_cell_expansion=True, + ... use_shared_styles=True + ... ) .. py:function:: lit(value) -> expr.Expr @@ -1565,9 +2041,17 @@ .. py:data:: DFSchema +.. py:data:: col + :type: Col + +.. py:data:: column + :type: Col + .. py:data:: udaf .. py:data:: udf +.. py:data:: udtf + .. py:data:: udwf
diff --git a/_sources/autoapi/datafusion/udf/index.rst.txt b/_sources/autoapi/datafusion/udf/index.rst.txt index 882bbcd..c11c9e6 100644 --- a/_sources/autoapi/datafusion/udf/index.rst.txt +++ b/_sources/autoapi/datafusion/udf/index.rst.txt
@@ -5,594 +5,7 @@ .. autoapi-nested-parse:: - Provides the user-defined functions for evaluation of dataframes. - - - -Attributes ----------- - -.. autoapisummary:: - - datafusion.udf._R - datafusion.udf.udaf - datafusion.udf.udf - datafusion.udf.udwf - - -Classes -------- - -.. autoapisummary:: - - datafusion.udf.Accumulator - datafusion.udf.AggregateUDF - datafusion.udf.ScalarUDF - datafusion.udf.Volatility - datafusion.udf.WindowEvaluator - datafusion.udf.WindowUDF - - -Module Contents ---------------- - -.. py:class:: Accumulator - - Defines how an :py:class:`AggregateUDF` accumulates values. - - - .. py:method:: evaluate() -> pyarrow.Scalar - :abstractmethod: - - - Return the resultant value. - - - - .. py:method:: merge(states: list[pyarrow.Array]) -> None - :abstractmethod: - - - Merge a set of states. - - - - .. py:method:: state() -> list[pyarrow.Scalar] - :abstractmethod: - - - Return the current state. - - - - .. py:method:: update(*values: pyarrow.Array) -> None - :abstractmethod: - - - Evaluate an array of values and update state. - - - -.. py:class:: AggregateUDF(name: str, accumulator: Callable[[], Accumulator], input_types: list[pyarrow.DataType], return_type: pyarrow.DataType, state_type: list[pyarrow.DataType], volatility: Volatility | str) - - Class for performing scalar user-defined functions (UDF). - - Aggregate UDFs operate on a group of rows and return a single value. See - also :py:class:`ScalarUDF` for operating on a row by row basis. - - Instantiate a user-defined aggregate function (UDAF). - - See :py:func:`udaf` for a convenience function and argument - descriptions. - - - .. py:method:: __call__(*args: datafusion.expr.Expr) -> datafusion.expr.Expr - - Execute the UDAF. - - This function is not typically called by an end user. These calls will - occur during the evaluation of the dataframe. - - - - .. py:method:: udaf(input_types: pyarrow.DataType | list[pyarrow.DataType], return_type: pyarrow.DataType, state_type: list[pyarrow.DataType], volatility: Volatility | str, name: Optional[str] = None) -> Callable[Ellipsis, AggregateUDF] - udaf(accum: Callable[[], Accumulator], input_types: pyarrow.DataType | list[pyarrow.DataType], return_type: pyarrow.DataType, state_type: list[pyarrow.DataType], volatility: Volatility | str, name: Optional[str] = None) -> AggregateUDF - :staticmethod: - - - Create a new User-Defined Aggregate Function (UDAF). - - This class allows you to define an **aggregate function** that can be used in - data aggregation or window function calls. - - Usage: - - **As a function**: Call `udaf(accum, input_types, return_type, state_type, - volatility, name)`. - - **As a decorator**: Use `@udaf(input_types, return_type, state_type, - volatility, name)`. - When using `udaf` as a decorator, **do not pass `accum` explicitly**. - - **Function example:** - - If your `:py:class:Accumulator` can be instantiated with no arguments, you - can simply pass it's type as `accum`. If you need to pass additional - arguments to it's constructor, you can define a lambda or a factory method. - During runtime the `:py:class:Accumulator` will be constructed for every - instance in which this UDAF is used. The following examples are all valid. - ``` - import pyarrow as pa - import pyarrow.compute as pc - - class Summarize(Accumulator): - def __init__(self, bias: float = 0.0): - self._sum = pa.scalar(bias) - - def state(self) -> list[pa.Scalar]: - return [self._sum] - - def update(self, values: pa.Array) -> None: - self._sum = pa.scalar(self._sum.as_py() + pc.sum(values).as_py()) - - def merge(self, states: list[pa.Array]) -> None: - self._sum = pa.scalar(self._sum.as_py() + pc.sum(states[0]).as_py()) - - def evaluate(self) -> pa.Scalar: - return self._sum - - def sum_bias_10() -> Summarize: - return Summarize(10.0) - - udaf1 = udaf(Summarize, pa.float64(), pa.float64(), [pa.float64()], - "immutable") - udaf2 = udaf(sum_bias_10, pa.float64(), pa.float64(), [pa.float64()], - "immutable") - udaf3 = udaf(lambda: Summarize(20.0), pa.float64(), pa.float64(), - [pa.float64()], "immutable") - ``` - - **Decorator example:** - ``` - @udaf(pa.float64(), pa.float64(), [pa.float64()], "immutable") - def udf4() -> Summarize: - return Summarize(10.0) - ``` - - :param accum: The accumulator python function. **Only needed when calling as a - function. Skip this argument when using `udaf` as a decorator.** - :param input_types: The data types of the arguments to ``accum``. - :param return_type: The data type of the return value. - :param state_type: The data types of the intermediate accumulation. - :param volatility: See :py:class:`Volatility` for allowed values. - :param name: A descriptive name for the function. - - :returns: A user-defined aggregate function, which can be used in either data - aggregation or window function calls. - - - - .. py:attribute:: _udaf - - -.. py:class:: ScalarUDF(name: str, func: Callable[Ellipsis, _R], input_types: pyarrow.DataType | list[pyarrow.DataType], return_type: _R, volatility: Volatility | str) - - Class for performing scalar user-defined functions (UDF). - - Scalar UDFs operate on a row by row basis. See also :py:class:`AggregateUDF` for - operating on a group of rows. - - Instantiate a scalar user-defined function (UDF). - - See helper method :py:func:`udf` for argument details. - - - .. py:method:: __call__(*args: datafusion.expr.Expr) -> datafusion.expr.Expr - - Execute the UDF. - - This function is not typically called by an end user. These calls will - occur during the evaluation of the dataframe. - - - - .. py:method:: udf(input_types: list[pyarrow.DataType], return_type: _R, volatility: Volatility | str, name: Optional[str] = None) -> Callable[Ellipsis, ScalarUDF] - udf(func: Callable[Ellipsis, _R], input_types: list[pyarrow.DataType], return_type: _R, volatility: Volatility | str, name: Optional[str] = None) -> ScalarUDF - :staticmethod: - - - Create a new User-Defined Function (UDF). - - This class can be used both as a **function** and as a **decorator**. - - Usage: - - **As a function**: Call `udf(func, input_types, return_type, volatility, - name)`. - - **As a decorator**: Use `@udf(input_types, return_type, volatility, - name)`. In this case, do **not** pass `func` explicitly. - - :param func: **Only needed when calling as a function.** - Skip this argument when using `udf` as a decorator. - :type func: Callable, optional - :param input_types: The data types of the arguments - to `func`. This list must be of the same length as the number of - arguments. - :type input_types: list[pa.DataType] - :param return_type: The data type of the return value from the function. - :type return_type: _R - :param volatility: See `Volatility` for allowed values. - :type volatility: Volatility | str - :param name: A descriptive name for the function. - :type name: Optional[str] - - :returns: A user-defined function that can be used in SQL expressions, - data aggregation, or window function calls. - - .. rubric:: Example - - **Using `udf` as a function:** - ``` - def double_func(x): - return x * 2 - double_udf = udf(double_func, [pa.int32()], pa.int32(), - "volatile", "double_it") - ``` - - **Using `udf` as a decorator:** - ``` - @udf([pa.int32()], pa.int32(), "volatile", "double_it") - def double_udf(x): - return x * 2 - ``` - - - - .. py:attribute:: _udf - - -.. py:class:: Volatility(*args, **kwds) - - Bases: :py:obj:`enum.Enum` - - - Defines how stable or volatile a function is. - - When setting the volatility of a function, you can either pass this - enumeration or a ``str``. The ``str`` equivalent is the lower case value of the - name (`"immutable"`, `"stable"`, or `"volatile"`). - - - .. py:method:: __str__() -> str - - Returns the string equivalent. - - - - .. py:attribute:: Immutable - :value: 1 - - - An immutable function will always return the same output when given the - same input. - - DataFusion will attempt to inline immutable functions during planning. - - - .. py:attribute:: Stable - :value: 2 - - - Returns the same value for a given input within a single queries. - - A stable function may return different values given the same input across - different queries but must return the same value for a given input within a - query. An example of this is the ``Now`` function. DataFusion will attempt to - inline ``Stable`` functions during planning, when possible. For query - ``select col1, now() from t1``, it might take a while to execute but ``now()`` - column will be the same for each output row, which is evaluated during - planning. - - - .. py:attribute:: Volatile - :value: 3 - - - A volatile function may change the return value from evaluation to - evaluation. - - Multiple invocations of a volatile function may return different results - when used in the same query. An example of this is the random() function. - DataFusion can not evaluate such functions during planning. In the query - ``select col1, random() from t1``, ``random()`` function will be evaluated - for each output row, resulting in a unique random value for each row. - - -.. py:class:: WindowEvaluator - - Evaluator class for user-defined window functions (UDWF). - - It is up to the user to decide which evaluate function is appropriate. - - +------------------------+--------------------------------+------------------+---------------------------+ - | ``uses_window_frame`` | ``supports_bounded_execution`` | ``include_rank`` | function_to_implement | - +========================+================================+==================+===========================+ - | False (default) | False (default) | False (default) | ``evaluate_all`` | - +------------------------+--------------------------------+------------------+---------------------------+ - | False | True | False | ``evaluate`` | - +------------------------+--------------------------------+------------------+---------------------------+ - | False | True/False | True | ``evaluate_all_with_rank``| - +------------------------+--------------------------------+------------------+---------------------------+ - | True | True/False | True/False | ``evaluate`` | - +------------------------+--------------------------------+------------------+---------------------------+ - - - .. py:method:: evaluate(values: list[pyarrow.Array], eval_range: tuple[int, int]) -> pyarrow.Scalar - - Evaluate window function on a range of rows in an input partition. - - This is the simplest and most general function to implement - but also the least performant as it creates output one row at - a time. It is typically much faster to implement stateful - evaluation using one of the other specialized methods on this - trait. - - Returns a [`ScalarValue`] that is the value of the window - function within `range` for the entire partition. Argument - `values` contains the evaluation result of function arguments - and evaluation results of ORDER BY expressions. If function has a - single argument, `values[1..]` will contain ORDER BY expression results. - - - - .. py:method:: evaluate_all(values: list[pyarrow.Array], num_rows: int) -> pyarrow.Array - - Evaluate a window function on an entire input partition. - - This function is called once per input *partition* for window functions that - *do not use* values from the window frame, such as - :py:func:`~datafusion.functions.row_number`, - :py:func:`~datafusion.functions.rank`, - :py:func:`~datafusion.functions.dense_rank`, - :py:func:`~datafusion.functions.percent_rank`, - :py:func:`~datafusion.functions.cume_dist`, - :py:func:`~datafusion.functions.lead`, - and :py:func:`~datafusion.functions.lag`. - - It produces the result of all rows in a single pass. It - expects to receive the entire partition as the ``value`` and - must produce an output column with one output row for every - input row. - - ``num_rows`` is required to correctly compute the output in case - ``len(values) == 0`` - - Implementing this function is an optimization. Certain window - functions are not affected by the window frame definition or - the query doesn't have a frame, and ``evaluate`` skips the - (costly) window frame boundary calculation and the overhead of - calling ``evaluate`` for each output row. - - For example, the `LAG` built in window function does not use - the values of its window frame (it can be computed in one shot - on the entire partition with ``Self::evaluate_all`` regardless of the - window defined in the ``OVER`` clause) - - .. code-block:: text - - lag(x, 1) OVER (ORDER BY z ROWS BETWEEN 2 PRECEDING AND 3 FOLLOWING) - - However, ``avg()`` computes the average in the window and thus - does use its window frame. - - .. code-block:: text - - avg(x) OVER (PARTITION BY y ORDER BY z ROWS BETWEEN 2 PRECEDING AND 3 FOLLOWING) - - - - .. py:method:: evaluate_all_with_rank(num_rows: int, ranks_in_partition: list[tuple[int, int]]) -> pyarrow.Array - - Called for window functions that only need the rank of a row. - - Evaluate the partition evaluator against the partition using - the row ranks. For example, ``rank(col("a"))`` produces - - .. code-block:: text - - a | rank - - + ---- - A | 1 - A | 1 - C | 3 - D | 4 - D | 4 - - For this case, `num_rows` would be `5` and the - `ranks_in_partition` would be called with - - .. code-block:: text - - [ - (0,1), - (2,2), - (3,4), - ] - - The user must implement this method if ``include_rank`` returns True. - - - - .. py:method:: get_range(idx: int, num_rows: int) -> tuple[int, int] - - Return the range for the window fuction. - - If `uses_window_frame` flag is `false`. This method is used to - calculate required range for the window function during - stateful execution. - - Generally there is no required range, hence by default this - returns smallest range(current row). e.g seeing current row is - enough to calculate window result (such as row_number, rank, - etc) - - :param idx:: Current index: - :param num_rows: Number of rows. - - - - .. py:method:: include_rank() -> bool - - Can this function be evaluated with (only) rank? - - - - .. py:method:: is_causal() -> bool - - Get whether evaluator needs future data for its result. - - - - .. py:method:: memoize() -> None - - Perform a memoize operation to improve performance. - - When the window frame has a fixed beginning (e.g UNBOUNDED - PRECEDING), some functions such as FIRST_VALUE and - NTH_VALUE do not need the (unbounded) input once they have - seen a certain amount of input. - - `memoize` is called after each input batch is processed, and - such functions can save whatever they need - - - - .. py:method:: supports_bounded_execution() -> bool - - Can the window function be incrementally computed using bounded memory? - - - - .. py:method:: uses_window_frame() -> bool - - Does the window function use the values from the window frame? - - - -.. py:class:: WindowUDF(name: str, func: Callable[[], WindowEvaluator], input_types: list[pyarrow.DataType], return_type: pyarrow.DataType, volatility: Volatility | str) - - Class for performing window user-defined functions (UDF). - - Window UDFs operate on a partition of rows. See - also :py:class:`ScalarUDF` for operating on a row by row basis. - - Instantiate a user-defined window function (UDWF). - - See :py:func:`udwf` for a convenience function and argument - descriptions. - - - .. py:method:: __call__(*args: datafusion.expr.Expr) -> datafusion.expr.Expr - - Execute the UDWF. - - This function is not typically called by an end user. These calls will - occur during the evaluation of the dataframe. - - - - .. py:method:: _create_window_udf(func: Callable[[], WindowEvaluator], input_types: pyarrow.DataType | list[pyarrow.DataType], return_type: pyarrow.DataType, volatility: Volatility | str, name: Optional[str] = None) -> WindowUDF - :staticmethod: - - - Create a WindowUDF instance from function arguments. - - - - .. py:method:: _create_window_udf_decorator(input_types: pyarrow.DataType | list[pyarrow.DataType], return_type: pyarrow.DataType, volatility: Volatility | str, name: Optional[str] = None) -> Callable[[Callable[[], WindowEvaluator]], Callable[Ellipsis, datafusion.expr.Expr]] - :staticmethod: - - - Create a decorator for a WindowUDF. - - - - .. py:method:: _get_default_name(func: Callable) -> str - :staticmethod: - - - Get the default name for a function based on its attributes. - - - - .. py:method:: _normalize_input_types(input_types: pyarrow.DataType | list[pyarrow.DataType]) -> list[pyarrow.DataType] - :staticmethod: - - - Convert a single DataType to a list if needed. - - - - .. py:method:: udwf(input_types: pyarrow.DataType | list[pyarrow.DataType], return_type: pyarrow.DataType, volatility: Volatility | str, name: Optional[str] = None) -> Callable[Ellipsis, WindowUDF] - udwf(func: Callable[[], WindowEvaluator], input_types: pyarrow.DataType | list[pyarrow.DataType], return_type: pyarrow.DataType, volatility: Volatility | str, name: Optional[str] = None) -> WindowUDF - :staticmethod: - - - Create a new User-Defined Window Function (UDWF). - - This class can be used both as a **function** and as a **decorator**. - - Usage: - - **As a function**: Call `udwf(func, input_types, return_type, volatility, - name)`. - - **As a decorator**: Use `@udwf(input_types, return_type, volatility, - name)`. When using `udwf` as a decorator, **do not pass `func` - explicitly**. - - **Function example:** - ``` - import pyarrow as pa - - class BiasedNumbers(WindowEvaluator): - def __init__(self, start: int = 0) -> None: - self.start = start - - def evaluate_all(self, values: list[pa.Array], - num_rows: int) -> pa.Array: - return pa.array([self.start + i for i in range(num_rows)]) - - def bias_10() -> BiasedNumbers: - return BiasedNumbers(10) - - udwf1 = udwf(BiasedNumbers, pa.int64(), pa.int64(), "immutable") - udwf2 = udwf(bias_10, pa.int64(), pa.int64(), "immutable") - udwf3 = udwf(lambda: BiasedNumbers(20), pa.int64(), pa.int64(), "immutable") - - ``` - - **Decorator example:** - ``` - @udwf(pa.int64(), pa.int64(), "immutable") - def biased_numbers() -> BiasedNumbers: - return BiasedNumbers(10) - ``` - - :param func: **Only needed when calling as a function. Skip this argument when - using `udwf` as a decorator.** - :param input_types: The data types of the arguments. - :param return_type: The data type of the return value. - :param volatility: See :py:class:`Volatility` for allowed values. - :param name: A descriptive name for the function. - - :returns: A user-defined window function that can be used in window function calls. - - - - .. py:attribute:: _udwf - - -.. py:data:: _R - -.. py:data:: udaf + Deprecated module for user defined functions. -.. py:data:: udf -.. py:data:: udwf
diff --git a/_sources/autoapi/datafusion/unparser/index.rst.txt b/_sources/autoapi/datafusion/unparser/index.rst.txt new file mode 100644 index 0000000..be2a352 --- /dev/null +++ b/_sources/autoapi/datafusion/unparser/index.rst.txt
@@ -0,0 +1,97 @@ +datafusion.unparser +=================== + +.. py:module:: datafusion.unparser + +.. autoapi-nested-parse:: + + This module provides support for unparsing datafusion plans to SQL. + + For additional information about unparsing, see https://docs.rs/datafusion-sql/latest/datafusion_sql/unparser/index.html + + + +Classes +------- + +.. autoapisummary:: + + datafusion.unparser.Dialect + datafusion.unparser.Unparser + + +Module Contents +--------------- + +.. py:class:: Dialect(dialect: datafusion._internal.unparser.Dialect) + + DataFusion data catalog. + + This constructor is not typically called by the end user. + + + .. py:method:: default() -> Dialect + :staticmethod: + + + Create a new default dialect. + + + + .. py:method:: duckdb() -> Dialect + :staticmethod: + + + Create a new DuckDB dialect. + + + + .. py:method:: mysql() -> Dialect + :staticmethod: + + + Create a new MySQL dialect. + + + + .. py:method:: postgres() -> Dialect + :staticmethod: + + + Create a new PostgreSQL dialect. + + + + .. py:method:: sqlite() -> Dialect + :staticmethod: + + + Create a new SQLite dialect. + + + + .. py:attribute:: dialect + + +.. py:class:: Unparser(dialect: Dialect) + + DataFusion unparser. + + This constructor is not typically called by the end user. + + + .. py:method:: plan_to_sql(plan: datafusion.plan.LogicalPlan) -> str + + Convert a logical plan to a SQL string. + + + + .. py:method:: with_pretty(pretty: bool) -> Unparser + + Set the pretty flag. + + + + .. py:attribute:: unparser + +
diff --git a/_sources/autoapi/datafusion/user_defined/index.rst.txt b/_sources/autoapi/datafusion/user_defined/index.rst.txt new file mode 100644 index 0000000..d6c30ab --- /dev/null +++ b/_sources/autoapi/datafusion/user_defined/index.rst.txt
@@ -0,0 +1,642 @@ +datafusion.user_defined +======================= + +.. py:module:: datafusion.user_defined + +.. autoapi-nested-parse:: + + Provides the user-defined functions for evaluation of dataframes. + + + +Attributes +---------- + +.. autoapisummary:: + + datafusion.user_defined._R + datafusion.user_defined.udaf + datafusion.user_defined.udf + datafusion.user_defined.udtf + datafusion.user_defined.udwf + + +Classes +------- + +.. autoapisummary:: + + datafusion.user_defined.Accumulator + datafusion.user_defined.AggregateUDF + datafusion.user_defined.ScalarUDF + datafusion.user_defined.TableFunction + datafusion.user_defined.Volatility + datafusion.user_defined.WindowEvaluator + datafusion.user_defined.WindowUDF + + +Module Contents +--------------- + +.. py:class:: Accumulator + + Defines how an :py:class:`AggregateUDF` accumulates values. + + + .. py:method:: evaluate() -> pyarrow.Scalar + :abstractmethod: + + + Return the resultant value. + + + + .. py:method:: merge(states: list[pyarrow.Array]) -> None + :abstractmethod: + + + Merge a set of states. + + + + .. py:method:: state() -> list[pyarrow.Scalar] + :abstractmethod: + + + Return the current state. + + + + .. py:method:: update(*values: pyarrow.Array) -> None + :abstractmethod: + + + Evaluate an array of values and update state. + + + +.. py:class:: AggregateUDF(name: str, accumulator: Callable[[], Accumulator], input_types: list[pyarrow.DataType], return_type: pyarrow.DataType, state_type: list[pyarrow.DataType], volatility: Volatility | str) + + Class for performing scalar user-defined functions (UDF). + + Aggregate UDFs operate on a group of rows and return a single value. See + also :py:class:`ScalarUDF` for operating on a row by row basis. + + Instantiate a user-defined aggregate function (UDAF). + + See :py:func:`udaf` for a convenience function and argument + descriptions. + + + .. py:method:: __call__(*args: datafusion.expr.Expr) -> datafusion.expr.Expr + + Execute the UDAF. + + This function is not typically called by an end user. These calls will + occur during the evaluation of the dataframe. + + + + .. py:method:: udaf(input_types: pyarrow.DataType | list[pyarrow.DataType], return_type: pyarrow.DataType, state_type: list[pyarrow.DataType], volatility: Volatility | str, name: Optional[str] = None) -> Callable[Ellipsis, AggregateUDF] + udaf(accum: Callable[[], Accumulator], input_types: pyarrow.DataType | list[pyarrow.DataType], return_type: pyarrow.DataType, state_type: list[pyarrow.DataType], volatility: Volatility | str, name: Optional[str] = None) -> AggregateUDF + :staticmethod: + + + Create a new User-Defined Aggregate Function (UDAF). + + This class allows you to define an aggregate function that can be used in + data aggregation or window function calls. + + Usage: + - As a function: ``udaf(accum, input_types, return_type, state_type, volatility, name)``. + - As a decorator: ``@udaf(input_types, return_type, state_type, volatility, name)``. + When using ``udaf`` as a decorator, do not pass ``accum`` explicitly. + + Function example: + + If your :py:class:`Accumulator` can be instantiated with no arguments, you + can simply pass it's type as `accum`. If you need to pass additional + arguments to it's constructor, you can define a lambda or a factory method. + During runtime the :py:class:`Accumulator` will be constructed for every + instance in which this UDAF is used. The following examples are all valid:: + + import pyarrow as pa + import pyarrow.compute as pc + + class Summarize(Accumulator): + def __init__(self, bias: float = 0.0): + self._sum = pa.scalar(bias) + + def state(self) -> list[pa.Scalar]: + return [self._sum] + + def update(self, values: pa.Array) -> None: + self._sum = pa.scalar(self._sum.as_py() + pc.sum(values).as_py()) + + def merge(self, states: list[pa.Array]) -> None: + self._sum = pa.scalar(self._sum.as_py() + pc.sum(states[0]).as_py()) + + def evaluate(self) -> pa.Scalar: + return self._sum + + def sum_bias_10() -> Summarize: + return Summarize(10.0) + + udaf1 = udaf(Summarize, pa.float64(), pa.float64(), [pa.float64()], + "immutable") + udaf2 = udaf(sum_bias_10, pa.float64(), pa.float64(), [pa.float64()], + "immutable") + udaf3 = udaf(lambda: Summarize(20.0), pa.float64(), pa.float64(), + [pa.float64()], "immutable") + + Decorator example::: + + @udaf(pa.float64(), pa.float64(), [pa.float64()], "immutable") + def udf4() -> Summarize: + return Summarize(10.0) + + :param accum: The accumulator python function. Only needed when calling as a + function. Skip this argument when using ``udaf`` as a decorator. + :param input_types: The data types of the arguments to ``accum``. + :param return_type: The data type of the return value. + :param state_type: The data types of the intermediate accumulation. + :param volatility: See :py:class:`Volatility` for allowed values. + :param name: A descriptive name for the function. + + :returns: A user-defined aggregate function, which can be used in either data + aggregation or window function calls. + + + + .. py:attribute:: _udaf + + +.. py:class:: ScalarUDF(name: str, func: Callable[Ellipsis, _R], input_types: pyarrow.DataType | list[pyarrow.DataType], return_type: _R, volatility: Volatility | str) + + Class for performing scalar user-defined functions (UDF). + + Scalar UDFs operate on a row by row basis. See also :py:class:`AggregateUDF` for + operating on a group of rows. + + Instantiate a scalar user-defined function (UDF). + + See helper method :py:func:`udf` for argument details. + + + .. py:method:: __call__(*args: datafusion.expr.Expr) -> datafusion.expr.Expr + + Execute the UDF. + + This function is not typically called by an end user. These calls will + occur during the evaluation of the dataframe. + + + + .. py:method:: udf(input_types: list[pyarrow.DataType], return_type: _R, volatility: Volatility | str, name: Optional[str] = None) -> Callable[Ellipsis, ScalarUDF] + udf(func: Callable[Ellipsis, _R], input_types: list[pyarrow.DataType], return_type: _R, volatility: Volatility | str, name: Optional[str] = None) -> ScalarUDF + :staticmethod: + + + Create a new User-Defined Function (UDF). + + This class can be used both as either a function or a decorator. + + Usage: + - As a function: ``udf(func, input_types, return_type, volatility, name)``. + - As a decorator: ``@udf(input_types, return_type, volatility, name)``. + When used a decorator, do **not** pass ``func`` explicitly. + + :param func: Only needed when calling as a function. + Skip this argument when using ``udf`` as a decorator. + :type func: Callable, optional + :param input_types: The data types of the arguments + to ``func``. This list must be of the same length as the number of + arguments. + :type input_types: list[pa.DataType] + :param return_type: The data type of the return value from the function. + :type return_type: _R + :param volatility: See `Volatility` for allowed values. + :type volatility: Volatility | str + :param name: A descriptive name for the function. + :type name: Optional[str] + + :returns: A user-defined function that can be used in SQL expressions, + data aggregation, or window function calls. + + Example: Using ``udf`` as a function:: + + def double_func(x): + return x * 2 + double_udf = udf(double_func, [pa.int32()], pa.int32(), + "volatile", "double_it") + + Example: Using ``udf`` as a decorator:: + + @udf([pa.int32()], pa.int32(), "volatile", "double_it") + def double_udf(x): + return x * 2 + + + + .. py:attribute:: _udf + + +.. py:class:: TableFunction(name: str, func: Callable[[], any]) + + Class for performing user-defined table functions (UDTF). + + Table functions generate new table providers based on the + input expressions. + + Instantiate a user-defined table function (UDTF). + + See :py:func:`udtf` for a convenience function and argument + descriptions. + + + .. py:method:: __call__(*args: datafusion.expr.Expr) -> Any + + Execute the UDTF and return a table provider. + + + + .. py:method:: __repr__() -> str + + User printable representation. + + + + .. py:method:: _create_table_udf(func: Callable[Ellipsis, Any], name: str) -> TableFunction + :staticmethod: + + + Create a TableFunction instance from function arguments. + + + + .. py:method:: _create_table_udf_decorator(name: Optional[str] = None) -> Callable[[Callable[[], WindowEvaluator]], Callable[Ellipsis, datafusion.expr.Expr]] + :staticmethod: + + + Create a decorator for a WindowUDF. + + + + .. py:method:: udtf(name: str) -> Callable[Ellipsis, Any] + udtf(func: Callable[[], Any], name: str) -> TableFunction + :staticmethod: + + + Create a new User-Defined Table Function (UDTF). + + + + .. py:attribute:: _udtf + + +.. py:class:: Volatility(*args, **kwds) + + Bases: :py:obj:`enum.Enum` + + + Defines how stable or volatile a function is. + + When setting the volatility of a function, you can either pass this + enumeration or a ``str``. The ``str`` equivalent is the lower case value of the + name (`"immutable"`, `"stable"`, or `"volatile"`). + + + .. py:method:: __str__() -> str + + Returns the string equivalent. + + + + .. py:attribute:: Immutable + :value: 1 + + + An immutable function will always return the same output when given the + same input. + + DataFusion will attempt to inline immutable functions during planning. + + + .. py:attribute:: Stable + :value: 2 + + + Returns the same value for a given input within a single queries. + + A stable function may return different values given the same input across + different queries but must return the same value for a given input within a + query. An example of this is the ``Now`` function. DataFusion will attempt to + inline ``Stable`` functions during planning, when possible. For query + ``select col1, now() from t1``, it might take a while to execute but ``now()`` + column will be the same for each output row, which is evaluated during + planning. + + + .. py:attribute:: Volatile + :value: 3 + + + A volatile function may change the return value from evaluation to + evaluation. + + Multiple invocations of a volatile function may return different results + when used in the same query. An example of this is the random() function. + DataFusion can not evaluate such functions during planning. In the query + ``select col1, random() from t1``, ``random()`` function will be evaluated + for each output row, resulting in a unique random value for each row. + + +.. py:class:: WindowEvaluator + + Evaluator class for user-defined window functions (UDWF). + + It is up to the user to decide which evaluate function is appropriate. + + +------------------------+--------------------------------+------------------+---------------------------+ + | ``uses_window_frame`` | ``supports_bounded_execution`` | ``include_rank`` | function_to_implement | + +========================+================================+==================+===========================+ + | False (default) | False (default) | False (default) | ``evaluate_all`` | + +------------------------+--------------------------------+------------------+---------------------------+ + | False | True | False | ``evaluate`` | + +------------------------+--------------------------------+------------------+---------------------------+ + | False | True/False | True | ``evaluate_all_with_rank``| + +------------------------+--------------------------------+------------------+---------------------------+ + | True | True/False | True/False | ``evaluate`` | + +------------------------+--------------------------------+------------------+---------------------------+ + + + .. py:method:: evaluate(values: list[pyarrow.Array], eval_range: tuple[int, int]) -> pyarrow.Scalar + + Evaluate window function on a range of rows in an input partition. + + This is the simplest and most general function to implement + but also the least performant as it creates output one row at + a time. It is typically much faster to implement stateful + evaluation using one of the other specialized methods on this + trait. + + Returns a [`ScalarValue`] that is the value of the window + function within `range` for the entire partition. Argument + `values` contains the evaluation result of function arguments + and evaluation results of ORDER BY expressions. If function has a + single argument, `values[1..]` will contain ORDER BY expression results. + + + + .. py:method:: evaluate_all(values: list[pyarrow.Array], num_rows: int) -> pyarrow.Array + + Evaluate a window function on an entire input partition. + + This function is called once per input *partition* for window functions that + *do not use* values from the window frame, such as + :py:func:`~datafusion.functions.row_number`, + :py:func:`~datafusion.functions.rank`, + :py:func:`~datafusion.functions.dense_rank`, + :py:func:`~datafusion.functions.percent_rank`, + :py:func:`~datafusion.functions.cume_dist`, + :py:func:`~datafusion.functions.lead`, + and :py:func:`~datafusion.functions.lag`. + + It produces the result of all rows in a single pass. It + expects to receive the entire partition as the ``value`` and + must produce an output column with one output row for every + input row. + + ``num_rows`` is required to correctly compute the output in case + ``len(values) == 0`` + + Implementing this function is an optimization. Certain window + functions are not affected by the window frame definition or + the query doesn't have a frame, and ``evaluate`` skips the + (costly) window frame boundary calculation and the overhead of + calling ``evaluate`` for each output row. + + For example, the `LAG` built in window function does not use + the values of its window frame (it can be computed in one shot + on the entire partition with ``Self::evaluate_all`` regardless of the + window defined in the ``OVER`` clause) + + .. code-block:: text + + lag(x, 1) OVER (ORDER BY z ROWS BETWEEN 2 PRECEDING AND 3 FOLLOWING) + + However, ``avg()`` computes the average in the window and thus + does use its window frame. + + .. code-block:: text + + avg(x) OVER (PARTITION BY y ORDER BY z ROWS BETWEEN 2 PRECEDING AND 3 FOLLOWING) + + + + .. py:method:: evaluate_all_with_rank(num_rows: int, ranks_in_partition: list[tuple[int, int]]) -> pyarrow.Array + + Called for window functions that only need the rank of a row. + + Evaluate the partition evaluator against the partition using + the row ranks. For example, ``rank(col("a"))`` produces + + .. code-block:: text + + a | rank + - + ---- + A | 1 + A | 1 + C | 3 + D | 4 + D | 4 + + For this case, `num_rows` would be `5` and the + `ranks_in_partition` would be called with + + .. code-block:: text + + [ + (0,1), + (2,2), + (3,4), + ] + + The user must implement this method if ``include_rank`` returns True. + + + + .. py:method:: get_range(idx: int, num_rows: int) -> tuple[int, int] + + Return the range for the window fuction. + + If `uses_window_frame` flag is `false`. This method is used to + calculate required range for the window function during + stateful execution. + + Generally there is no required range, hence by default this + returns smallest range(current row). e.g seeing current row is + enough to calculate window result (such as row_number, rank, + etc) + + :param idx:: Current index: + :param num_rows: Number of rows. + + + + .. py:method:: include_rank() -> bool + + Can this function be evaluated with (only) rank? + + + + .. py:method:: is_causal() -> bool + + Get whether evaluator needs future data for its result. + + + + .. py:method:: memoize() -> None + + Perform a memoize operation to improve performance. + + When the window frame has a fixed beginning (e.g UNBOUNDED + PRECEDING), some functions such as FIRST_VALUE and + NTH_VALUE do not need the (unbounded) input once they have + seen a certain amount of input. + + `memoize` is called after each input batch is processed, and + such functions can save whatever they need + + + + .. py:method:: supports_bounded_execution() -> bool + + Can the window function be incrementally computed using bounded memory? + + + + .. py:method:: uses_window_frame() -> bool + + Does the window function use the values from the window frame? + + + +.. py:class:: WindowUDF(name: str, func: Callable[[], WindowEvaluator], input_types: list[pyarrow.DataType], return_type: pyarrow.DataType, volatility: Volatility | str) + + Class for performing window user-defined functions (UDF). + + Window UDFs operate on a partition of rows. See + also :py:class:`ScalarUDF` for operating on a row by row basis. + + Instantiate a user-defined window function (UDWF). + + See :py:func:`udwf` for a convenience function and argument + descriptions. + + + .. py:method:: __call__(*args: datafusion.expr.Expr) -> datafusion.expr.Expr + + Execute the UDWF. + + This function is not typically called by an end user. These calls will + occur during the evaluation of the dataframe. + + + + .. py:method:: _create_window_udf(func: Callable[[], WindowEvaluator], input_types: pyarrow.DataType | list[pyarrow.DataType], return_type: pyarrow.DataType, volatility: Volatility | str, name: Optional[str] = None) -> WindowUDF + :staticmethod: + + + Create a WindowUDF instance from function arguments. + + + + .. py:method:: _create_window_udf_decorator(input_types: pyarrow.DataType | list[pyarrow.DataType], return_type: pyarrow.DataType, volatility: Volatility | str, name: Optional[str] = None) -> Callable[[Callable[[], WindowEvaluator]], Callable[Ellipsis, datafusion.expr.Expr]] + :staticmethod: + + + Create a decorator for a WindowUDF. + + + + .. py:method:: _get_default_name(func: Callable) -> str + :staticmethod: + + + Get the default name for a function based on its attributes. + + + + .. py:method:: _normalize_input_types(input_types: pyarrow.DataType | list[pyarrow.DataType]) -> list[pyarrow.DataType] + :staticmethod: + + + Convert a single DataType to a list if needed. + + + + .. py:method:: udwf(input_types: pyarrow.DataType | list[pyarrow.DataType], return_type: pyarrow.DataType, volatility: Volatility | str, name: Optional[str] = None) -> Callable[Ellipsis, WindowUDF] + udwf(func: Callable[[], WindowEvaluator], input_types: pyarrow.DataType | list[pyarrow.DataType], return_type: pyarrow.DataType, volatility: Volatility | str, name: Optional[str] = None) -> WindowUDF + :staticmethod: + + + Create a new User-Defined Window Function (UDWF). + + This class can be used both as either a function or a decorator. + + Usage: + - As a function: ``udwf(func, input_types, return_type, volatility, name)``. + - As a decorator: ``@udwf(input_types, return_type, volatility, name)``. + When using ``udwf`` as a decorator, do not pass ``func`` explicitly. + + Function example:: + + import pyarrow as pa + + class BiasedNumbers(WindowEvaluator): + def __init__(self, start: int = 0) -> None: + self.start = start + + def evaluate_all(self, values: list[pa.Array], + num_rows: int) -> pa.Array: + return pa.array([self.start + i for i in range(num_rows)]) + + def bias_10() -> BiasedNumbers: + return BiasedNumbers(10) + + udwf1 = udwf(BiasedNumbers, pa.int64(), pa.int64(), "immutable") + udwf2 = udwf(bias_10, pa.int64(), pa.int64(), "immutable") + udwf3 = udwf(lambda: BiasedNumbers(20), pa.int64(), pa.int64(), "immutable") + + + Decorator example:: + + @udwf(pa.int64(), pa.int64(), "immutable") + def biased_numbers() -> BiasedNumbers: + return BiasedNumbers(10) + + :param func: Only needed when calling as a function. Skip this argument when + using ``udwf`` as a decorator. + :param input_types: The data types of the arguments. + :param return_type: The data type of the return value. + :param volatility: See :py:class:`Volatility` for allowed values. + :param name: A descriptive name for the function. + + :returns: A user-defined window function that can be used in window function calls. + + + + .. py:attribute:: _udwf + + +.. py:data:: _R + +.. py:data:: udaf + +.. py:data:: udf + +.. py:data:: udtf + +.. py:data:: udwf +
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt index 558b2d5..c187938 100644 --- a/_sources/index.rst.txt +++ b/_sources/index.rst.txt
@@ -72,6 +72,7 @@ user-guide/introduction user-guide/basics user-guide/data-sources + user-guide/dataframe user-guide/common-operations/index user-guide/io/index user-guide/configuration
diff --git a/_sources/user-guide/basics.rst.txt b/_sources/user-guide/basics.rst.txt index f37378a..2975d9a 100644 --- a/_sources/user-guide/basics.rst.txt +++ b/_sources/user-guide/basics.rst.txt
@@ -20,8 +20,9 @@ Concepts ======== -In this section, we will cover a basic example to introduce a few key concepts. We will use the same -source file as described in the :ref:`Introduction <guide>`, the Pokemon data set. +In this section, we will cover a basic example to introduce a few key concepts. We will use the +2021 Yellow Taxi Trip Records (`download <https://d37ci6vzurychx.cloudfront.net/trip-data/yellow_tripdata_2021-01.parquet>`_), +from the `TLC Trip Record Data <https://www.nyc.gov/site/tlc/about/tlc-trip-record-data.page>`_. .. ipython:: python @@ -72,6 +73,8 @@ calling the transformation methods, such as :py:func:`~datafusion.dataframe.DataFrame.filter`, :py:func:`~datafusion.dataframe.DataFrame.select`, :py:func:`~datafusion.dataframe.DataFrame.aggregate`, and :py:func:`~datafusion.dataframe.DataFrame.limit` to build up a query definition. +For more details on working with DataFrames, including visualization options and conversion to other formats, see :doc:`dataframe`. + Expressions -----------
diff --git a/_sources/user-guide/common-operations/functions.rst.txt b/_sources/user-guide/common-operations/functions.rst.txt index 12097be..d458d3e 100644 --- a/_sources/user-guide/common-operations/functions.rst.txt +++ b/_sources/user-guide/common-operations/functions.rst.txt
@@ -129,3 +129,24 @@ .limit(20) .to_pandas() ) + + +Handling Missing Values +===================== + +DataFusion provides methods to handle missing values in DataFrames: + +fill_null +--------- + +The ``fill_null()`` method replaces NULL values in specified columns with a provided value: + +.. code-block:: python + + # Fill all NULL values with 0 where possible + df = df.fill_null(0) + + # Fill NULL values only in specific string columns + df = df.fill_null("missing", subset=["name", "category"]) + +The fill value will be cast to match each column's type. If casting fails for a column, that column remains unchanged.
diff --git a/_sources/user-guide/common-operations/udf-and-udfa.rst.txt b/_sources/user-guide/common-operations/udf-and-udfa.rst.txt index ffd7a05..0830fa8 100644 --- a/_sources/user-guide/common-operations/udf-and-udfa.rst.txt +++ b/_sources/user-guide/common-operations/udf-and-udfa.rst.txt
@@ -26,7 +26,7 @@ When writing a user-defined function that can operate on a row by row basis, these are called Scalar Functions. You can define your own scalar function by calling -:py:func:`~datafusion.udf.ScalarUDF.udf` . +:py:func:`~datafusion.user_defined.ScalarUDF.udf` . The basic definition of a scalar UDF is a python function that takes one or more `pyarrow <https://arrow.apache.org/docs/python/index.html>`_ arrays and returns a single array as @@ -93,9 +93,9 @@ Aggregate Functions ------------------- -The :py:func:`~datafusion.udf.AggregateUDF.udaf` function allows you to define User-Defined +The :py:func:`~datafusion.user_defined.AggregateUDF.udaf` function allows you to define User-Defined Aggregate Functions (UDAFs). To use this you must implement an -:py:class:`~datafusion.udf.Accumulator` that determines how the aggregation is performed. +:py:class:`~datafusion.user_defined.Accumulator` that determines how the aggregation is performed. When defining a UDAF there are four methods you need to implement. The ``update`` function takes the array(s) of input and updates the internal state of the accumulator. You should define this function @@ -153,8 +153,8 @@ ---------------- To implement a User-Defined Window Function (UDWF) you must call the -:py:func:`~datafusion.udf.WindowUDF.udwf` function using a class that implements the abstract -class :py:class:`~datafusion.udf.WindowEvaluator`. +:py:func:`~datafusion.user_defined.WindowUDF.udwf` function using a class that implements the abstract +class :py:class:`~datafusion.user_defined.WindowEvaluator`. There are three methods of evaluation of UDWFs. @@ -207,7 +207,7 @@ import pyarrow as pa from datafusion import udwf, col, SessionContext - from datafusion.udf import WindowEvaluator + from datafusion.user_defined import WindowEvaluator class ExponentialSmooth(WindowEvaluator): def __init__(self, alpha: float) -> None: @@ -242,3 +242,35 @@ }) df.select("a", exp_smooth(col("a")).alias("smooth_a")).show() + +Table Functions +--------------- + +User Defined Table Functions are slightly different than the other functions +described here. These functions take any number of `Expr` arguments, but only +literal expressions are supported. Table functions must return a Table +Provider as described in the ref:`_io_custom_table_provider` page. + +Once you have a table function, you can register it with the session context +by using :py:func:`datafusion.context.SessionContext.register_udtf`. + +There are examples of both rust backed and python based table functions in the +examples folder of the repository. If you have a rust backed table function +that you wish to expose via PyO3, you need to expose it as a ``PyCapsule``. + +.. code-block:: rust + + #[pymethods] + impl MyTableFunction { + fn __datafusion_table_function__<'py>( + &self, + py: Python<'py>, + ) -> PyResult<Bound<'py, PyCapsule>> { + let name = cr"datafusion_table_function".into(); + + let func = self.clone(); + let provider = FFI_TableFunction::new(Arc::new(func), None); + + PyCapsule::new(py, provider, Some(name)) + } + }
diff --git a/_sources/user-guide/dataframe.rst.txt b/_sources/user-guide/dataframe.rst.txt new file mode 100644 index 0000000..11e3d7e --- /dev/null +++ b/_sources/user-guide/dataframe.rst.txt
@@ -0,0 +1,217 @@ +.. Licensed to the Apache Software Foundation (ASF) under one +.. or more contributor license agreements. See the NOTICE file +.. distributed with this work for additional information +.. regarding copyright ownership. The ASF licenses this file +.. to you under the Apache License, Version 2.0 (the +.. "License"); you may not use this file except in compliance +.. with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, +.. software distributed under the License is distributed on an +.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +.. KIND, either express or implied. See the License for the +.. specific language governing permissions and limitations +.. under the License. + +DataFrames +========== + +Overview +-------- + +DataFusion's DataFrame API provides a powerful interface for building and executing queries against data sources. +It offers a familiar API similar to pandas and other DataFrame libraries, but with the performance benefits of Rust +and Arrow. + +A DataFrame represents a logical plan that can be composed through operations like filtering, projection, and aggregation. +The actual execution happens when terminal operations like ``collect()`` or ``show()`` are called. + +Basic Usage +----------- + +.. code-block:: python + + import datafusion + from datafusion import col, lit + + # Create a context and register a data source + ctx = datafusion.SessionContext() + ctx.register_csv("my_table", "path/to/data.csv") + + # Create and manipulate a DataFrame + df = ctx.sql("SELECT * FROM my_table") + + # Or use the DataFrame API directly + df = (ctx.table("my_table") + .filter(col("age") > lit(25)) + .select([col("name"), col("age")])) + + # Execute and collect results + result = df.collect() + + # Display the first few rows + df.show() + +HTML Rendering +-------------- + +When working in Jupyter notebooks or other environments that support HTML rendering, DataFrames will +automatically display as formatted HTML tables, making it easier to visualize your data. + +The ``_repr_html_`` method is called automatically by Jupyter to render a DataFrame. This method +controls how DataFrames appear in notebook environments, providing a richer visualization than +plain text output. + +Customizing HTML Rendering +-------------------------- + +You can customize how DataFrames are rendered in HTML by configuring the formatter: + +.. code-block:: python + + from datafusion.html_formatter import configure_formatter + + # Change the default styling + configure_formatter( + max_cell_length=25, # Maximum characters in a cell before truncation + max_width=1000, # Maximum width in pixels + max_height=300, # Maximum height in pixels + max_memory_bytes=2097152, # Maximum memory for rendering (2MB) + min_rows_display=20, # Minimum number of rows to display + repr_rows=10, # Number of rows to display in __repr__ + enable_cell_expansion=True,# Allow expanding truncated cells + custom_css=None, # Additional custom CSS + show_truncation_message=True, # Show message when data is truncated + style_provider=None, # Custom styling provider + use_shared_styles=True # Share styles across tables + ) + +The formatter settings affect all DataFrames displayed after configuration. + +Custom Style Providers +---------------------- + +For advanced styling needs, you can create a custom style provider: + +.. code-block:: python + + from datafusion.html_formatter import StyleProvider, configure_formatter + + class MyStyleProvider(StyleProvider): + def get_table_styles(self): + return { + "table": "border-collapse: collapse; width: 100%;", + "th": "background-color: #007bff; color: white; padding: 8px; text-align: left;", + "td": "border: 1px solid #ddd; padding: 8px;", + "tr:nth-child(even)": "background-color: #f2f2f2;", + } + + def get_value_styles(self, dtype, value): + """Return custom styles for specific values""" + if dtype == "float" and value < 0: + return "color: red;" + return None + + # Apply the custom style provider + configure_formatter(style_provider=MyStyleProvider()) + +Performance Optimization with Shared Styles +------------------------------------------- +The ``use_shared_styles`` parameter (enabled by default) optimizes performance when displaying +multiple DataFrames in notebook environments: + + .. code-block:: python + from datafusion.html_formatter import StyleProvider, configure_formatter + # Default: Use shared styles (recommended for notebooks) + configure_formatter(use_shared_styles=True) + + # Disable shared styles (each DataFrame includes its own styles) + configure_formatter(use_shared_styles=False) + +When ``use_shared_styles=True``: +- CSS styles and JavaScript are included only once per notebook session +- This reduces HTML output size and prevents style duplication +- Improves rendering performance with many DataFrames +- Applies consistent styling across all DataFrames + +Creating a Custom Formatter +--------------------------- + +For complete control over rendering, you can implement a custom formatter: + +.. code-block:: python + + from datafusion.html_formatter import Formatter, get_formatter + + class MyFormatter(Formatter): + def format_html(self, batches, schema, has_more=False, table_uuid=None): + # Create your custom HTML here + html = "<div class='my-custom-table'>" + # ... formatting logic ... + html += "</div>" + return html + + # Set as the global formatter + configure_formatter(formatter_class=MyFormatter) + + # Or use the formatter just for specific operations + formatter = get_formatter() + custom_html = formatter.format_html(batches, schema) + +Managing Formatters +------------------- + +Reset to default formatting: + +.. code-block:: python + + from datafusion.html_formatter import reset_formatter + + # Reset to default settings + reset_formatter() + +Get the current formatter settings: + +.. code-block:: python + + from datafusion.html_formatter import get_formatter + + formatter = get_formatter() + print(formatter.max_rows) + print(formatter.theme) + +Contextual Formatting +--------------------- + +You can also use a context manager to temporarily change formatting settings: + +.. code-block:: python + + from datafusion.html_formatter import formatting_context + + # Default formatting + df.show() + + # Temporarily use different formatting + with formatting_context(max_rows=100, theme="dark"): + df.show() # Will use the temporary settings + + # Back to default formatting + df.show() + +Memory and Display Controls +--------------------------- + +You can control how much data is displayed and how much memory is used for rendering: + + .. code-block:: python + + configure_formatter( + max_memory_bytes=4 * 1024 * 1024, # 4MB maximum memory for display + min_rows_display=50, # Always show at least 50 rows + repr_rows=20 # Show 20 rows in __repr__ output + ) + +These parameters help balance comprehensive data display against performance considerations. \ No newline at end of file
diff --git a/autoapi/datafusion/catalog/index.html b/autoapi/datafusion/catalog/index.html index d79211a..7629a57 100644 --- a/autoapi/datafusion/catalog/index.html +++ b/autoapi/datafusion/catalog/index.html
@@ -34,7 +34,7 @@ <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script> <link rel="index" title="Index" href="../../../genindex.html" /> <link rel="search" title="Search" href="../../../search.html" /> - <link rel="next" title="datafusion.context" href="../context/index.html" /> + <link rel="next" title="datafusion.col" href="../col/index.html" /> <link rel="prev" title="datafusion" href="../index.html" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="docsearch:language" content="en"> @@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../user-guide/common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul> @@ -631,10 +656,10 @@ <p class="prev-next-title">datafusion</p> </div> </a> - <a class='right-next' id="next-link" href="../context/index.html" title="next page"> + <a class='right-next' id="next-link" href="../col/index.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> - <p class="prev-next-title">datafusion.context</p> + <p class="prev-next-title">datafusion.col</p> </div> <i class="fas fa-angle-right"></i> </a>
diff --git a/autoapi/datafusion/col/index.html b/autoapi/datafusion/col/index.html new file mode 100644 index 0000000..77e23e0 --- /dev/null +++ b/autoapi/datafusion/col/index.html
@@ -0,0 +1,540 @@ +<!DOCTYPE html> + +<html lang="en" data-content_root="../../../"> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> + + <title>datafusion.col — Apache Arrow DataFusion documentation</title> + + <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> +<link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> + + + <link rel="stylesheet" + href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> + <link rel="preload" as="font" type="font/woff2" crossorigin + href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> + <link rel="preload" as="font" type="font/woff2" crossorigin + href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> + + + + + + <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=8f2a1f02" /> + <link rel="stylesheet" type="text/css" href="../../../_static/styles/pydata-sphinx-theme.css?v=1140d252" /> + <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=4ae1632d" /> + <link rel="stylesheet" type="text/css" href="../../../_static/theme_overrides.css?v=dca7052a" /> + + <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> + + <script src="../../../_static/documentation_options.js?v=8a448e45"></script> + <script src="../../../_static/doctools.js?v=9bcbadda"></script> + <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="datafusion.context" href="../context/index.html" /> + <link rel="prev" title="datafusion.catalog" href="../catalog/index.html" /> + <meta name="viewport" content="width=device-width, initial-scale=1" /> + <meta name="docsearch:language" content="en"> + + + <!-- Google Analytics --> + + </head> + <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80"> + + <div class="container-fluid" id="banner"></div> + + + + + <div class="container-xl"> + <div class="row"> + + + <!-- Only show if we have sidebars configured, else just a small margin --> + <div class="col-12 col-md-3 bd-sidebar"> + <div class="sidebar-start-items"> +<a class="navbar-brand" href="../../../index.html"> + <img src="../../../_static/images/2x_bgwhite_original.png" class="logo" alt="logo"> +</a> + +<form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> + <i class="icon fas fa-search"></i> + <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" > +</form> + +<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation"> + <div class="bd-toc-item active"> + + <p aria-level="2" class="caption" role="heading"> + <span class="caption-text"> + LINKS + </span> +</p> +<ul class="nav bd-sidenav"> + <li class="toctree-l1"> + <a class="reference external" href="https://github.com/apache/datafusion-python"> + Github and Issue Tracker + </a> + </li> + <li class="toctree-l1"> + <a class="reference external" href="https://docs.rs/datafusion/latest/datafusion/"> + Rust's API Docs + </a> + </li> + <li class="toctree-l1"> + <a class="reference external" href="https://github.com/apache/datafusion/blob/main/CODE_OF_CONDUCT.md"> + Code of conduct + </a> + </li> + <li class="toctree-l1"> + <a class="reference external" href="https://github.com/apache/datafusion-python/tree/main/examples"> + Examples + </a> + </li> +</ul> +<p aria-level="2" class="caption" role="heading"> + <span class="caption-text"> + USER GUIDE + </span> +</p> +<ul class="nav bd-sidenav"> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/introduction.html"> + Introduction + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/basics.html"> + Concepts + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/data-sources.html"> + Data Sources + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/dataframe.html"> + DataFrames + </a> + </li> + <li class="toctree-l1 has-children"> + <a class="reference internal" href="../../../user-guide/common-operations/index.html"> + Common Operations + </a> + <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/> + <label for="toctree-checkbox-1"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/views.html"> + Registering Views + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/basic-info.html"> + Basic Operations + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/select-and-filter.html"> + Column Selections + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/expressions.html"> + Expressions + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/joins.html"> + Joins + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/functions.html"> + Functions + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/aggregations.html"> + Aggregation + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/windows.html"> + Window Functions + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/udf-and-udfa.html"> + User-Defined Functions + </a> + </li> + </ul> + </li> + <li class="toctree-l1 has-children"> + <a class="reference internal" href="../../../user-guide/io/index.html"> + IO + </a> + <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/> + <label for="toctree-checkbox-2"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/arrow.html"> + Arrow + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/avro.html"> + Avro + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/csv.html"> + CSV + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/json.html"> + JSON + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/parquet.html"> + Parquet + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/table_provider.html"> + Custom Table Provider + </a> + </li> + </ul> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/configuration.html"> + Configuration + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/sql.html"> + SQL + </a> + </li> +</ul> +<p aria-level="2" class="caption" role="heading"> + <span class="caption-text"> + CONTRIBUTOR GUIDE + </span> +</p> +<ul class="nav bd-sidenav"> + <li class="toctree-l1"> + <a class="reference internal" href="../../../contributor-guide/introduction.html"> + Introduction + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../contributor-guide/ffi.html"> + Python Extensions + </a> + </li> +</ul> +<p aria-level="2" class="caption" role="heading"> + <span class="caption-text"> + API + </span> +</p> +<ul class="current nav bd-sidenav"> + <li class="toctree-l1 current active has-children"> + <a class="reference internal" href="../../index.html"> + API Reference + </a> + <input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/> + <label for="toctree-checkbox-3"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul class="current"> + <li class="toctree-l2 current active has-children"> + <a class="reference internal" href="../index.html"> + datafusion + </a> + <input checked="" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/> + <label for="toctree-checkbox-4"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul class="current"> + <li class="toctree-l3"> + <a class="reference internal" href="../catalog/index.html"> + datafusion.catalog + </a> + </li> + <li class="toctree-l3 current active"> + <a class="current reference internal" href="#"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../context/index.html"> + datafusion.context + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../dataframe/index.html"> + datafusion.dataframe + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../expr/index.html"> + datafusion.expr + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../functions/index.html"> + datafusion.functions + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> + <li class="toctree-l3 has-children"> + <a class="reference internal" href="../input/index.html"> + datafusion.input + </a> + <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/> + <label for="toctree-checkbox-5"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul> + <li class="toctree-l4"> + <a class="reference internal" href="../input/base/index.html"> + datafusion.input.base + </a> + </li> + <li class="toctree-l4"> + <a class="reference internal" href="../input/location/index.html"> + datafusion.input.location + </a> + </li> + </ul> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../io/index.html"> + datafusion.io + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../object_store/index.html"> + datafusion.object_store + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../plan/index.html"> + datafusion.plan + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../record_batch/index.html"> + datafusion.record_batch + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../substrait/index.html"> + datafusion.substrait + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../udf/index.html"> + datafusion.udf + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../user_defined/index.html"> + datafusion.user_defined + </a> + </li> + </ul> + </li> + </ul> + </li> +</ul> + + + </div> +</nav> + </div> + <div class="sidebar-end-items"> + </div> + </div> + + + + + <div class="d-none d-xl-block col-xl-2 bd-toc"> + + + <div class="toc-item"> + +<div class="tocsection onthispage pt-5 pb-3"> + <i class="fas fa-list"></i> On this page +</div> + +<nav id="bd-toc-nav"> + <ul class="visible nav section-nav flex-column"> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#attributes"> + Attributes + </a> + </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#module-contents"> + Module Contents + </a> + <ul class="visible nav section-nav flex-column"> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.col.col"> + <code class="docutils literal notranslate"> + <span class="pre"> + col + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.col.column"> + <code class="docutils literal notranslate"> + <span class="pre"> + column + </span> + </code> + </a> + </li> + </ul> + </li> +</ul> + +</nav> + </div> + + <div class="toc-item"> + + </div> + + + </div> + + + + + + + <main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main"> + + <div> + + <section id="module-datafusion.col"> +<span id="datafusion-col"></span><h1>datafusion.col<a class="headerlink" href="#module-datafusion.col" title="Link to this heading">¶</a></h1> +<p>Col class.</p> +<section id="attributes"> +<h2>Attributes<a class="headerlink" href="#attributes" title="Link to this heading">¶</a></h2> +<table class="autosummary longtable table autosummary"> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.col.col" title="datafusion.col.col"><code class="xref py py-obj docutils literal notranslate"><span class="pre">col</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.col.column" title="datafusion.col.column"><code class="xref py py-obj docutils literal notranslate"><span class="pre">column</span></code></a></p></td> +<td><p></p></td> +</tr> +</tbody> +</table> +</section> +<section id="module-contents"> +<h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to this heading">¶</a></h2> +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.col.col"> +<span class="sig-prename descclassname"><span class="pre">datafusion.col.</span></span><span class="sig-name descname"><span class="pre">col</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Col</span></em><a class="headerlink" href="#datafusion.col.col" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.col.column"> +<span class="sig-prename descclassname"><span class="pre">datafusion.col.</span></span><span class="sig-name descname"><span class="pre">column</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Col</span></em><a class="headerlink" href="#datafusion.col.column" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +</section> +</section> + + + </div> + + + <!-- Previous / next buttons --> +<div class='prev-next-area'> + <a class='left-prev' id="prev-link" href="../catalog/index.html" title="previous page"> + <i class="fas fa-angle-left"></i> + <div class="prev-next-info"> + <p class="prev-next-subtitle">previous</p> + <p class="prev-next-title">datafusion.catalog</p> + </div> + </a> + <a class='right-next' id="next-link" href="../context/index.html" title="next page"> + <div class="prev-next-info"> + <p class="prev-next-subtitle">next</p> + <p class="prev-next-title">datafusion.context</p> + </div> + <i class="fas fa-angle-right"></i> + </a> +</div> + + </main> + + + </div> + </div> + + <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> + +<!-- Based on pydata_sphinx_theme/footer.html --> +<footer class="footer mt-5 mt-md-0"> + <div class="container"> + + <div class="footer-item"> + <p class="copyright"> + © Copyright 2019-2024, Apache Software Foundation.<br> +</p> + </div> + + <div class="footer-item"> + <p class="sphinx-version"> +Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.1.3.<br> +</p> + </div> + + <div class="footer-item"> + <p>Apache Arrow DataFusion, Arrow DataFusion, Apache, the Apache feather logo, and the Apache Arrow DataFusion project logo</p> + <p>are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.</p> + </div> + </div> +</footer> + + + </body> +</html> \ No newline at end of file
diff --git a/autoapi/datafusion/context/index.html b/autoapi/datafusion/context/index.html index 7715d6a..097fcd7 100644 --- a/autoapi/datafusion/context/index.html +++ b/autoapi/datafusion/context/index.html
@@ -35,7 +35,7 @@ <link rel="index" title="Index" href="../../../genindex.html" /> <link rel="search" title="Search" href="../../../search.html" /> <link rel="next" title="datafusion.dataframe" href="../dataframe/index.html" /> - <link rel="prev" title="datafusion.catalog" href="../catalog/index.html" /> + <link rel="prev" title="datafusion.col" href="../col/index.html" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="docsearch:language" content="en"> @@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../user-guide/common-operations/index.html"> Common Operations @@ -275,6 +280,11 @@ datafusion.catalog </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../col/index.html"> + datafusion.col + </a> + </li> <li class="toctree-l3 current active"> <a class="current reference internal" href="#"> datafusion.context @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul> @@ -990,6 +1015,15 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.context.SessionContext.register_udtf"> + <code class="docutils literal notranslate"> + <span class="pre"> + SessionContext.register_udtf() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.context.SessionContext.register_udwf"> <code class="docutils literal notranslate"> <span class="pre"> @@ -2081,19 +2115,25 @@ <dl class="py method"> <dt class="sig sig-object py" id="datafusion.context.SessionContext.register_udaf"> -<span class="sig-name descname"><span class="pre">register_udaf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">udaf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../udf/index.html#datafusion.udf.AggregateUDF" title="datafusion.udf.AggregateUDF"><span class="pre">datafusion.udf.AggregateUDF</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.context.SessionContext.register_udaf" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">register_udaf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">udaf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../user_defined/index.html#datafusion.user_defined.AggregateUDF" title="datafusion.user_defined.AggregateUDF"><span class="pre">datafusion.user_defined.AggregateUDF</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.context.SessionContext.register_udaf" title="Link to this definition">¶</a></dt> <dd><p>Register a user-defined aggregation function (UDAF) with the context.</p> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="datafusion.context.SessionContext.register_udf"> -<span class="sig-name descname"><span class="pre">register_udf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">udf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../udf/index.html#datafusion.udf.ScalarUDF" title="datafusion.udf.ScalarUDF"><span class="pre">datafusion.udf.ScalarUDF</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.context.SessionContext.register_udf" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">register_udf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">udf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../user_defined/index.html#datafusion.user_defined.ScalarUDF" title="datafusion.user_defined.ScalarUDF"><span class="pre">datafusion.user_defined.ScalarUDF</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.context.SessionContext.register_udf" title="Link to this definition">¶</a></dt> <dd><p>Register a user-defined function (UDF) with the context.</p> </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.context.SessionContext.register_udtf"> +<span class="sig-name descname"><span class="pre">register_udtf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../user_defined/index.html#datafusion.user_defined.TableFunction" title="datafusion.user_defined.TableFunction"><span class="pre">datafusion.user_defined.TableFunction</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.context.SessionContext.register_udtf" title="Link to this definition">¶</a></dt> +<dd><p>Register a user defined table function.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.context.SessionContext.register_udwf"> -<span class="sig-name descname"><span class="pre">register_udwf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">udwf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../udf/index.html#datafusion.udf.WindowUDF" title="datafusion.udf.WindowUDF"><span class="pre">datafusion.udf.WindowUDF</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.context.SessionContext.register_udwf" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">register_udwf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">udwf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../user_defined/index.html#datafusion.user_defined.WindowUDF" title="datafusion.user_defined.WindowUDF"><span class="pre">datafusion.user_defined.WindowUDF</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.context.SessionContext.register_udwf" title="Link to this definition">¶</a></dt> <dd><p>Register a user-defined window function (UDWF) with the context.</p> </dd></dl> @@ -2198,11 +2238,11 @@ <!-- Previous / next buttons --> <div class='prev-next-area'> - <a class='left-prev' id="prev-link" href="../catalog/index.html" title="previous page"> + <a class='left-prev' id="prev-link" href="../col/index.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> - <p class="prev-next-title">datafusion.catalog</p> + <p class="prev-next-title">datafusion.col</p> </div> </a> <a class='right-next' id="next-link" href="../dataframe/index.html" title="next page">
diff --git a/autoapi/datafusion/dataframe/index.html b/autoapi/datafusion/dataframe/index.html index 2ed6116..75e62c2 100644 --- a/autoapi/datafusion/dataframe/index.html +++ b/autoapi/datafusion/dataframe/index.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../user-guide/common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul> @@ -649,6 +674,15 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.dataframe.DataFrame.fill_null"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrame.fill_null() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.dataframe.DataFrame.filter"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1307,6 +1341,35 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.dataframe.DataFrame.fill_null"> +<span class="sig-name descname"><span class="pre">fill_null</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.dataframe.DataFrame" title="datafusion.dataframe.DataFrame"><span class="pre">DataFrame</span></a></span></span><a class="headerlink" href="#datafusion.dataframe.DataFrame.fill_null" title="Link to this definition">¶</a></dt> +<dd><p>Fill null values in specified columns with a value.</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>value</strong> – Value to replace nulls with. Will be cast to match column type.</p></li> +<li><p><strong>subset</strong> – Optional list of column names to fill. If None, fills all columns.</p></li> +</ul> +</dd> +<dt class="field-even">Returns<span class="colon">:</span></dt> +<dd class="field-even"><p>DataFrame with null values replaced where type casting is possible</p> +</dd> +</dl> +<p class="rubric">Examples</p> +<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">df</span> <span class="o">=</span> <span class="n">df</span><span class="o">.</span><span class="n">fill_null</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> <span class="c1"># Fill all nulls with 0 where possible</span> +<span class="gp">>>> </span><span class="c1"># Fill nulls in specific string columns</span> +<span class="gp">>>> </span><span class="n">df</span> <span class="o">=</span> <span class="n">df</span><span class="o">.</span><span class="n">fill_null</span><span class="p">(</span><span class="s2">"missing"</span><span class="p">,</span> <span class="n">subset</span><span class="o">=</span><span class="p">[</span><span class="s2">"name"</span><span class="p">,</span> <span class="s2">"category"</span><span class="p">])</span> +</pre></div> +</div> +<p class="rubric">Notes</p> +<ul class="simple"> +<li><p>Only fills nulls in columns where the value can be cast to the column type</p></li> +<li><p>For columns where casting fails, the original column is kept unchanged</p></li> +<li><p>For columns not in subset, the original column is kept unchanged</p></li> +</ul> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.dataframe.DataFrame.filter"> <span class="sig-name descname"><span class="pre">filter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">predicates</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.dataframe.DataFrame" title="datafusion.dataframe.DataFrame"><span class="pre">DataFrame</span></a></span></span><a class="headerlink" href="#datafusion.dataframe.DataFrame.filter" title="Link to this definition">¶</a></dt> <dd><p>Return a DataFrame for which <code class="docutils literal notranslate"><span class="pre">predicate</span></code> evaluates to <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
diff --git a/autoapi/datafusion/expr/index.html b/autoapi/datafusion/expr/index.html index ae12073..6241152 100644 --- a/autoapi/datafusion/expr/index.html +++ b/autoapi/datafusion/expr/index.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../user-guide/common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul> @@ -600,6 +625,33 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.abs"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.abs() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.acos"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.acos() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.acosh"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.acosh() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Expr.alias"> <code class="docutils literal notranslate"> <span class="pre"> @@ -609,6 +661,123 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.array_dims"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.array_dims() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.array_distinct"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.array_distinct() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.array_empty"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.array_empty() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.array_length"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.array_length() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.array_ndims"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.array_ndims() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.array_pop_back"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.array_pop_back() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.array_pop_front"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.array_pop_front() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.arrow_typeof"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.arrow_typeof() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.ascii"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.ascii() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.asin"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.asin() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.asinh"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.asinh() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.atan"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.atan() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.atanh"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.atanh() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Expr.between"> <code class="docutils literal notranslate"> <span class="pre"> @@ -618,6 +787,24 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.bit_length"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.bit_length() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.btrim"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.btrim() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Expr.canonical_name"> <code class="docutils literal notranslate"> <span class="pre"> @@ -627,6 +814,15 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.cardinality"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.cardinality() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Expr.cast"> <code class="docutils literal notranslate"> <span class="pre"> @@ -636,6 +832,51 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.cbrt"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.cbrt() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.ceil"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.ceil() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.char_length"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.char_length() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.character_length"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.character_length() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.chr"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.chr() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Expr.column"> <code class="docutils literal notranslate"> <span class="pre"> @@ -654,6 +895,42 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.cos"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.cos() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.cosh"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.cosh() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.cot"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.cot() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.degrees"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.degrees() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Expr.display_name"> <code class="docutils literal notranslate"> <span class="pre"> @@ -672,6 +949,33 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.empty"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.empty() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.exp"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.exp() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.factorial"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.factorial() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Expr.fill_nan"> <code class="docutils literal notranslate"> <span class="pre"> @@ -699,6 +1003,42 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.flatten"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.flatten() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.floor"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.floor() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.from_unixtime"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.from_unixtime() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.initcap"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.initcap() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Expr.is_not_null"> <code class="docutils literal notranslate"> <span class="pre"> @@ -717,6 +1057,69 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.isnan"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.isnan() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.iszero"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.iszero() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.length"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.length() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.list_dims"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.list_dims() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.list_distinct"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.list_distinct() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.list_length"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.list_length() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.list_ndims"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.list_ndims() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Expr.literal"> <code class="docutils literal notranslate"> <span class="pre"> @@ -726,6 +1129,60 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.ln"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.ln() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.log10"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.log10() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.log2"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.log2() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.lower"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.lower() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.ltrim"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.ltrim() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.md5"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.md5() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Expr.null_treatment"> <code class="docutils literal notranslate"> <span class="pre"> @@ -735,6 +1192,15 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.octet_length"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.octet_length() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Expr.order_by"> <code class="docutils literal notranslate"> <span class="pre"> @@ -771,6 +1237,24 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.radians"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.radians() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.reverse"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.reverse() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Expr.rex_call_operands"> <code class="docutils literal notranslate"> <span class="pre"> @@ -798,6 +1282,15 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.rtrim"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.rtrim() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Expr.schema_name"> <code class="docutils literal notranslate"> <span class="pre"> @@ -807,6 +1300,69 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.sha224"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.sha224() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.sha256"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.sha256() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.sha384"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.sha384() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.sha512"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.sha512() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.signum"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.signum() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.sin"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.sin() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.sinh"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.sinh() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Expr.sort"> <code class="docutils literal notranslate"> <span class="pre"> @@ -816,6 +1372,15 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.sqrt"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.sqrt() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Expr.string_literal"> <code class="docutils literal notranslate"> <span class="pre"> @@ -825,6 +1390,33 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.tan"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.tan() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.tanh"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.tanh() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.to_hex"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.to_hex() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Expr.to_variant"> <code class="docutils literal notranslate"> <span class="pre"> @@ -834,6 +1426,15 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.trim"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.trim() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Expr.types"> <code class="docutils literal notranslate"> <span class="pre"> @@ -843,6 +1444,15 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Expr.upper"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.upper() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Expr.variant_name"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1240,6 +1850,69 @@ </a> </li> <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.CopyTo"> + <code class="docutils literal notranslate"> + <span class="pre"> + CopyTo + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.CreateCatalog"> + <code class="docutils literal notranslate"> + <span class="pre"> + CreateCatalog + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.CreateCatalogSchema"> + <code class="docutils literal notranslate"> + <span class="pre"> + CreateCatalogSchema + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.CreateExternalTable"> + <code class="docutils literal notranslate"> + <span class="pre"> + CreateExternalTable + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.CreateFunction"> + <code class="docutils literal notranslate"> + <span class="pre"> + CreateFunction + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.CreateFunctionBody"> + <code class="docutils literal notranslate"> + <span class="pre"> + CreateFunctionBody + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.CreateIndex"> + <code class="docutils literal notranslate"> + <span class="pre"> + CreateIndex + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.CreateMemoryTable"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1258,6 +1931,24 @@ </a> </li> <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Deallocate"> + <code class="docutils literal notranslate"> + <span class="pre"> + Deallocate + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.DescribeTable"> + <code class="docutils literal notranslate"> + <span class="pre"> + DescribeTable + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Distinct"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1267,6 +1958,33 @@ </a> </li> <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.DmlStatement"> + <code class="docutils literal notranslate"> + <span class="pre"> + DmlStatement + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.DropCatalogSchema"> + <code class="docutils literal notranslate"> + <span class="pre"> + DropCatalogSchema + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.DropFunction"> + <code class="docutils literal notranslate"> + <span class="pre"> + DropFunction + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.DropTable"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1276,6 +1994,15 @@ </a> </li> <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.DropView"> + <code class="docutils literal notranslate"> + <span class="pre"> + DropView + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.EmptyRelation"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1285,6 +2012,15 @@ </a> </li> <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Execute"> + <code class="docutils literal notranslate"> + <span class="pre"> + Execute + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Exists"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1312,6 +2048,15 @@ </a> </li> <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.FileType"> + <code class="docutils literal notranslate"> + <span class="pre"> + FileType + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Filter"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1501,6 +2246,15 @@ </a> </li> <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.OperateFunctionArg"> + <code class="docutils literal notranslate"> + <span class="pre"> + OperateFunctionArg + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Partitioning"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1519,6 +2273,15 @@ </a> </li> <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Prepare"> + <code class="docutils literal notranslate"> + <span class="pre"> + Prepare + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Projection"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1528,6 +2291,15 @@ </a> </li> <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.RecursiveQuery"> + <code class="docutils literal notranslate"> + <span class="pre"> + RecursiveQuery + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.Repartition"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1555,6 +2327,15 @@ </a> </li> <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.SetVariable"> + <code class="docutils literal notranslate"> + <span class="pre"> + SetVariable + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.SimilarTo"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1600,6 +2381,51 @@ </a> </li> <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.TransactionAccessMode"> + <code class="docutils literal notranslate"> + <span class="pre"> + TransactionAccessMode + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.TransactionConclusion"> + <code class="docutils literal notranslate"> + <span class="pre"> + TransactionConclusion + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.TransactionEnd"> + <code class="docutils literal notranslate"> + <span class="pre"> + TransactionEnd + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.TransactionIsolationLevel"> + <code class="docutils literal notranslate"> + <span class="pre"> + TransactionIsolationLevel + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.TransactionStart"> + <code class="docutils literal notranslate"> + <span class="pre"> + TransactionStart + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.TryCast"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1636,6 +2462,15 @@ </a> </li> <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.expr.Values"> + <code class="docutils literal notranslate"> + <span class="pre"> + Values + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.expr.WindowExpr"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1702,19 +2537,61 @@ <tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Column" title="datafusion.expr.Column"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.CreateMemoryTable" title="datafusion.expr.CreateMemoryTable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CreateMemoryTable</span></code></a></p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.CopyTo" title="datafusion.expr.CopyTo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CopyTo</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.CreateView" title="datafusion.expr.CreateView"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CreateView</span></code></a></p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.CreateCatalog" title="datafusion.expr.CreateCatalog"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CreateCatalog</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Distinct" title="datafusion.expr.Distinct"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Distinct</span></code></a></p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.CreateCatalogSchema" title="datafusion.expr.CreateCatalogSchema"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CreateCatalogSchema</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.CreateExternalTable" title="datafusion.expr.CreateExternalTable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CreateExternalTable</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.CreateFunction" title="datafusion.expr.CreateFunction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CreateFunction</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.CreateFunctionBody" title="datafusion.expr.CreateFunctionBody"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CreateFunctionBody</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.CreateIndex" title="datafusion.expr.CreateIndex"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CreateIndex</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.CreateMemoryTable" title="datafusion.expr.CreateMemoryTable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CreateMemoryTable</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.CreateView" title="datafusion.expr.CreateView"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CreateView</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Deallocate" title="datafusion.expr.Deallocate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Deallocate</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.DescribeTable" title="datafusion.expr.DescribeTable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DescribeTable</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Distinct" title="datafusion.expr.Distinct"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Distinct</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.DmlStatement" title="datafusion.expr.DmlStatement"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DmlStatement</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.DropCatalogSchema" title="datafusion.expr.DropCatalogSchema"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DropCatalogSchema</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.DropFunction" title="datafusion.expr.DropFunction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DropFunction</span></code></a></p></td> <td><p></p></td> </tr> <tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.DropTable" title="datafusion.expr.DropTable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DropTable</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.EmptyRelation" title="datafusion.expr.EmptyRelation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">EmptyRelation</span></code></a></p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.DropView" title="datafusion.expr.DropView"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DropView</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.EmptyRelation" title="datafusion.expr.EmptyRelation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">EmptyRelation</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Execute" title="datafusion.expr.Execute"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Execute</span></code></a></p></td> <td><p></p></td> </tr> <tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Exists" title="datafusion.expr.Exists"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Exists</span></code></a></p></td> @@ -1726,67 +2603,73 @@ <tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Extension" title="datafusion.expr.Extension"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Extension</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Filter" title="datafusion.expr.Filter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Filter</span></code></a></p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.FileType" title="datafusion.expr.FileType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FileType</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.GroupingSet" title="datafusion.expr.GroupingSet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GroupingSet</span></code></a></p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Filter" title="datafusion.expr.Filter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Filter</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.ILike" title="datafusion.expr.ILike"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ILike</span></code></a></p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.GroupingSet" title="datafusion.expr.GroupingSet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GroupingSet</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.InList" title="datafusion.expr.InList"><code class="xref py py-obj docutils literal notranslate"><span class="pre">InList</span></code></a></p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.ILike" title="datafusion.expr.ILike"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ILike</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.InSubquery" title="datafusion.expr.InSubquery"><code class="xref py py-obj docutils literal notranslate"><span class="pre">InSubquery</span></code></a></p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.InList" title="datafusion.expr.InList"><code class="xref py py-obj docutils literal notranslate"><span class="pre">InList</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.IsFalse" title="datafusion.expr.IsFalse"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsFalse</span></code></a></p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.InSubquery" title="datafusion.expr.InSubquery"><code class="xref py py-obj docutils literal notranslate"><span class="pre">InSubquery</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.IsNotFalse" title="datafusion.expr.IsNotFalse"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsNotFalse</span></code></a></p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.IsFalse" title="datafusion.expr.IsFalse"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsFalse</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.IsNotNull" title="datafusion.expr.IsNotNull"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsNotNull</span></code></a></p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.IsNotFalse" title="datafusion.expr.IsNotFalse"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsNotFalse</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.IsNotTrue" title="datafusion.expr.IsNotTrue"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsNotTrue</span></code></a></p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.IsNotNull" title="datafusion.expr.IsNotNull"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsNotNull</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.IsNotUnknown" title="datafusion.expr.IsNotUnknown"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsNotUnknown</span></code></a></p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.IsNotTrue" title="datafusion.expr.IsNotTrue"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsNotTrue</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.IsNull" title="datafusion.expr.IsNull"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsNull</span></code></a></p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.IsNotUnknown" title="datafusion.expr.IsNotUnknown"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsNotUnknown</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.IsTrue" title="datafusion.expr.IsTrue"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsTrue</span></code></a></p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.IsNull" title="datafusion.expr.IsNull"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsNull</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.IsUnknown" title="datafusion.expr.IsUnknown"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsUnknown</span></code></a></p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.IsTrue" title="datafusion.expr.IsTrue"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsTrue</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Join" title="datafusion.expr.Join"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Join</span></code></a></p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.IsUnknown" title="datafusion.expr.IsUnknown"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsUnknown</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.JoinConstraint" title="datafusion.expr.JoinConstraint"><code class="xref py py-obj docutils literal notranslate"><span class="pre">JoinConstraint</span></code></a></p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Join" title="datafusion.expr.Join"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Join</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.JoinType" title="datafusion.expr.JoinType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">JoinType</span></code></a></p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.JoinConstraint" title="datafusion.expr.JoinConstraint"><code class="xref py py-obj docutils literal notranslate"><span class="pre">JoinConstraint</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Like" title="datafusion.expr.Like"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Like</span></code></a></p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.JoinType" title="datafusion.expr.JoinType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">JoinType</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Limit" title="datafusion.expr.Limit"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Limit</span></code></a></p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Like" title="datafusion.expr.Like"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Like</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Literal" title="datafusion.expr.Literal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Literal</span></code></a></p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Limit" title="datafusion.expr.Limit"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Limit</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Negative" title="datafusion.expr.Negative"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Negative</span></code></a></p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Literal" title="datafusion.expr.Literal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Literal</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Not" title="datafusion.expr.Not"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Not</span></code></a></p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Negative" title="datafusion.expr.Negative"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Negative</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Not" title="datafusion.expr.Not"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Not</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.OperateFunctionArg" title="datafusion.expr.OperateFunctionArg"><code class="xref py py-obj docutils literal notranslate"><span class="pre">OperateFunctionArg</span></code></a></p></td> <td><p></p></td> </tr> <tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Partitioning" title="datafusion.expr.Partitioning"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Partitioning</span></code></a></p></td> @@ -1795,7 +2678,13 @@ <tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Placeholder" title="datafusion.expr.Placeholder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Placeholder</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Projection" title="datafusion.expr.Projection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Projection</span></code></a></p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Prepare" title="datafusion.expr.Prepare"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Prepare</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Projection" title="datafusion.expr.Projection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Projection</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.RecursiveQuery" title="datafusion.expr.RecursiveQuery"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RecursiveQuery</span></code></a></p></td> <td><p></p></td> </tr> <tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Repartition" title="datafusion.expr.Repartition"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Repartition</span></code></a></p></td> @@ -1807,19 +2696,37 @@ <tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.ScalarVariable" title="datafusion.expr.ScalarVariable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ScalarVariable</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.SimilarTo" title="datafusion.expr.SimilarTo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SimilarTo</span></code></a></p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.SetVariable" title="datafusion.expr.SetVariable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SetVariable</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Sort" title="datafusion.expr.Sort"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Sort</span></code></a></p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.SimilarTo" title="datafusion.expr.SimilarTo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SimilarTo</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Subquery" title="datafusion.expr.Subquery"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Subquery</span></code></a></p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Sort" title="datafusion.expr.Sort"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Sort</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.SubqueryAlias" title="datafusion.expr.SubqueryAlias"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SubqueryAlias</span></code></a></p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Subquery" title="datafusion.expr.Subquery"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Subquery</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.TableScan" title="datafusion.expr.TableScan"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TableScan</span></code></a></p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.SubqueryAlias" title="datafusion.expr.SubqueryAlias"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SubqueryAlias</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.TableScan" title="datafusion.expr.TableScan"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TableScan</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.TransactionAccessMode" title="datafusion.expr.TransactionAccessMode"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TransactionAccessMode</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.TransactionConclusion" title="datafusion.expr.TransactionConclusion"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TransactionConclusion</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.TransactionEnd" title="datafusion.expr.TransactionEnd"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TransactionEnd</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.TransactionIsolationLevel" title="datafusion.expr.TransactionIsolationLevel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TransactionIsolationLevel</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.TransactionStart" title="datafusion.expr.TransactionStart"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TransactionStart</span></code></a></p></td> <td><p></p></td> </tr> <tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.TryCast" title="datafusion.expr.TryCast"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TryCast</span></code></a></p></td> @@ -1834,7 +2741,10 @@ <tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.UnnestExpr" title="datafusion.expr.UnnestExpr"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UnnestExpr</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.WindowExpr" title="datafusion.expr.WindowExpr"><code class="xref py py-obj docutils literal notranslate"><span class="pre">WindowExpr</span></code></a></p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Values" title="datafusion.expr.Values"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Values</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.WindowExpr" title="datafusion.expr.WindowExpr"><code class="xref py py-obj docutils literal notranslate"><span class="pre">WindowExpr</span></code></a></p></td> <td><p></p></td> </tr> </tbody> @@ -2035,9 +2945,130 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.abs"> +<span class="sig-name descname"><span class="pre">abs</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.abs" title="Link to this definition">¶</a></dt> +<dd><p>Return the absolute value of a given number.</p> +<section id="returns"> +<h3>Returns:<a class="headerlink" href="#returns" title="Link to this heading">¶</a></h3> +<dl class="simple"> +<dt>Expr</dt><dd><p>A new expression representing the absolute value of the input expression.</p> +</dd> +</dl> +</section> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.acos"> +<span class="sig-name descname"><span class="pre">acos</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.acos" title="Link to this definition">¶</a></dt> +<dd><p>Returns the arc cosine or inverse cosine of a number.</p> +<section id="id1"> +<h3>Returns:<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h3> +<dl class="simple"> +<dt>Expr</dt><dd><p>A new expression representing the arc cosine of the input expression.</p> +</dd> +</dl> +</section> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.acosh"> +<span class="sig-name descname"><span class="pre">acosh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.acosh" title="Link to this definition">¶</a></dt> +<dd><p>Returns inverse hyperbolic cosine.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.expr.Expr.alias"> -<span class="sig-name descname"><span class="pre">alias</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.alias" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">alias</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.alias" title="Link to this definition">¶</a></dt> <dd><p>Assign a name to the expression.</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>name</strong> – The name to assign to the expression.</p></li> +<li><p><strong>metadata</strong> – Optional metadata to attach to the expression.</p></li> +</ul> +</dd> +<dt class="field-even">Returns<span class="colon">:</span></dt> +<dd class="field-even"><p>A new expression with the assigned name.</p> +</dd> +</dl> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.array_dims"> +<span class="sig-name descname"><span class="pre">array_dims</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.array_dims" title="Link to this definition">¶</a></dt> +<dd><p>Returns an array of the array’s dimensions.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.array_distinct"> +<span class="sig-name descname"><span class="pre">array_distinct</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.array_distinct" title="Link to this definition">¶</a></dt> +<dd><p>Returns distinct values from the array after removing duplicates.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.array_empty"> +<span class="sig-name descname"><span class="pre">array_empty</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.array_empty" title="Link to this definition">¶</a></dt> +<dd><p>Returns a boolean indicating whether the array is empty.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.array_length"> +<span class="sig-name descname"><span class="pre">array_length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.array_length" title="Link to this definition">¶</a></dt> +<dd><p>Returns the length of the array.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.array_ndims"> +<span class="sig-name descname"><span class="pre">array_ndims</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.array_ndims" title="Link to this definition">¶</a></dt> +<dd><p>Returns the number of dimensions of the array.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.array_pop_back"> +<span class="sig-name descname"><span class="pre">array_pop_back</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.array_pop_back" title="Link to this definition">¶</a></dt> +<dd><p>Returns the array without the last element.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.array_pop_front"> +<span class="sig-name descname"><span class="pre">array_pop_front</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.array_pop_front" title="Link to this definition">¶</a></dt> +<dd><p>Returns the array without the first element.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.arrow_typeof"> +<span class="sig-name descname"><span class="pre">arrow_typeof</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.arrow_typeof" title="Link to this definition">¶</a></dt> +<dd><p>Returns the Arrow type of the expression.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.ascii"> +<span class="sig-name descname"><span class="pre">ascii</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.ascii" title="Link to this definition">¶</a></dt> +<dd><p>Returns the numeric code of the first character of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.asin"> +<span class="sig-name descname"><span class="pre">asin</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.asin" title="Link to this definition">¶</a></dt> +<dd><p>Returns the arc sine or inverse sine of a number.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.asinh"> +<span class="sig-name descname"><span class="pre">asinh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.asinh" title="Link to this definition">¶</a></dt> +<dd><p>Returns inverse hyperbolic sine.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.atan"> +<span class="sig-name descname"><span class="pre">atan</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.atan" title="Link to this definition">¶</a></dt> +<dd><p>Returns inverse tangent of a number.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.atanh"> +<span class="sig-name descname"><span class="pre">atanh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.atanh" title="Link to this definition">¶</a></dt> +<dd><p>Returns inverse hyperbolic tangent.</p> </dd></dl> <dl class="py method"> @@ -2056,18 +3087,66 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.bit_length"> +<span class="sig-name descname"><span class="pre">bit_length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.bit_length" title="Link to this definition">¶</a></dt> +<dd><p>Returns the number of bits in the string argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.btrim"> +<span class="sig-name descname"><span class="pre">btrim</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.btrim" title="Link to this definition">¶</a></dt> +<dd><p>Removes all characters, spaces by default, from both sides of a string.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.expr.Expr.canonical_name"> <span class="sig-name descname"><span class="pre">canonical_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.canonical_name" title="Link to this definition">¶</a></dt> <dd><p>Returns a complete string representation of this expression.</p> </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.cardinality"> +<span class="sig-name descname"><span class="pre">cardinality</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.cardinality" title="Link to this definition">¶</a></dt> +<dd><p>Returns the total number of elements in the array.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.expr.Expr.cast"> <span class="sig-name descname"><span class="pre">cast</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">to</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">type</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.cast" title="Link to this definition">¶</a></dt> <dd><p>Cast to a new data type.</p> </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.cbrt"> +<span class="sig-name descname"><span class="pre">cbrt</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.cbrt" title="Link to this definition">¶</a></dt> +<dd><p>Returns the cube root of a number.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.ceil"> +<span class="sig-name descname"><span class="pre">ceil</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.ceil" title="Link to this definition">¶</a></dt> +<dd><p>Returns the nearest integer greater than or equal to argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.char_length"> +<span class="sig-name descname"><span class="pre">char_length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.char_length" title="Link to this definition">¶</a></dt> +<dd><p>The number of characters in the <code class="docutils literal notranslate"><span class="pre">string</span></code>.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.character_length"> +<span class="sig-name descname"><span class="pre">character_length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.character_length" title="Link to this definition">¶</a></dt> +<dd><p>Returns the number of characters in the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.chr"> +<span class="sig-name descname"><span class="pre">chr</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.chr" title="Link to this definition">¶</a></dt> +<dd><p>Converts the Unicode code point to a UTF8 character.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.expr.Expr.column"> <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">column</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.column" title="Link to this definition">¶</a></dt> <dd><p>Creates a new expression representing a column.</p> @@ -2080,6 +3159,30 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.cos"> +<span class="sig-name descname"><span class="pre">cos</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.cos" title="Link to this definition">¶</a></dt> +<dd><p>Returns the cosine of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.cosh"> +<span class="sig-name descname"><span class="pre">cosh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.cosh" title="Link to this definition">¶</a></dt> +<dd><p>Returns the hyperbolic cosine of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.cot"> +<span class="sig-name descname"><span class="pre">cot</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.cot" title="Link to this definition">¶</a></dt> +<dd><p>Returns the cotangent of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.degrees"> +<span class="sig-name descname"><span class="pre">degrees</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.degrees" title="Link to this definition">¶</a></dt> +<dd><p>Converts the argument from radians to degrees.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.expr.Expr.display_name"> <span class="sig-name descname"><span class="pre">display_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.display_name" title="Link to this definition">¶</a></dt> <dd><p>Returns the name of this expression as it should appear in a schema.</p> @@ -2096,6 +3199,24 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.empty"> +<span class="sig-name descname"><span class="pre">empty</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.empty" title="Link to this definition">¶</a></dt> +<dd><p>This is an alias for <a class="reference internal" href="#datafusion.expr.Expr.array_empty" title="datafusion.expr.Expr.array_empty"><code class="xref py py-func docutils literal notranslate"><span class="pre">array_empty()</span></code></a>.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.exp"> +<span class="sig-name descname"><span class="pre">exp</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.exp" title="Link to this definition">¶</a></dt> +<dd><p>Returns the exponential of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.factorial"> +<span class="sig-name descname"><span class="pre">factorial</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.factorial" title="Link to this definition">¶</a></dt> +<dd><p>Returns the factorial of the argument.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.expr.Expr.fill_nan"> <span class="sig-name descname"><span class="pre">fill_nan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.fill_nan" title="Link to this definition">¶</a></dt> <dd><p>Fill NaN values with a provided value.</p> @@ -2117,6 +3238,32 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.flatten"> +<span class="sig-name descname"><span class="pre">flatten</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.flatten" title="Link to this definition">¶</a></dt> +<dd><p>Flattens an array of arrays into a single array.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.floor"> +<span class="sig-name descname"><span class="pre">floor</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.floor" title="Link to this definition">¶</a></dt> +<dd><p>Returns the nearest integer less than or equal to the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.from_unixtime"> +<span class="sig-name descname"><span class="pre">from_unixtime</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.from_unixtime" title="Link to this definition">¶</a></dt> +<dd><p>Converts an integer to RFC3339 timestamp format string.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.initcap"> +<span class="sig-name descname"><span class="pre">initcap</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.initcap" title="Link to this definition">¶</a></dt> +<dd><p>Set the initial letter of each word to capital.</p> +<p>Converts the first letter of each word in <code class="docutils literal notranslate"><span class="pre">string</span></code> to uppercase and the +remaining characters to lowercase.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.expr.Expr.is_not_null"> <span class="sig-name descname"><span class="pre">is_not_null</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.is_not_null" title="Link to this definition">¶</a></dt> <dd><p>Returns <code class="docutils literal notranslate"><span class="pre">True</span></code> if this expression is not null.</p> @@ -2129,6 +3276,52 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.isnan"> +<span class="sig-name descname"><span class="pre">isnan</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.isnan" title="Link to this definition">¶</a></dt> +<dd><p>Returns true if a given number is +NaN or -NaN otherwise returns false.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.iszero"> +<span class="sig-name descname"><span class="pre">iszero</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.iszero" title="Link to this definition">¶</a></dt> +<dd><p>Returns true if a given number is +0.0 or -0.0 otherwise returns false.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.length"> +<span class="sig-name descname"><span class="pre">length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.length" title="Link to this definition">¶</a></dt> +<dd><p>The number of characters in the <code class="docutils literal notranslate"><span class="pre">string</span></code>.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.list_dims"> +<span class="sig-name descname"><span class="pre">list_dims</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.list_dims" title="Link to this definition">¶</a></dt> +<dd><p>Returns an array of the array’s dimensions.</p> +<p>This is an alias for <a class="reference internal" href="#datafusion.expr.Expr.array_dims" title="datafusion.expr.Expr.array_dims"><code class="xref py py-func docutils literal notranslate"><span class="pre">array_dims()</span></code></a>.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.list_distinct"> +<span class="sig-name descname"><span class="pre">list_distinct</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.list_distinct" title="Link to this definition">¶</a></dt> +<dd><p>Returns distinct values from the array after removing duplicates.</p> +<p>This is an alias for <a class="reference internal" href="#datafusion.expr.Expr.array_distinct" title="datafusion.expr.Expr.array_distinct"><code class="xref py py-func docutils literal notranslate"><span class="pre">array_distinct()</span></code></a>.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.list_length"> +<span class="sig-name descname"><span class="pre">list_length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.list_length" title="Link to this definition">¶</a></dt> +<dd><p>Returns the length of the array.</p> +<p>This is an alias for <a class="reference internal" href="#datafusion.expr.Expr.array_length" title="datafusion.expr.Expr.array_length"><code class="xref py py-func docutils literal notranslate"><span class="pre">array_length()</span></code></a>.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.list_ndims"> +<span class="sig-name descname"><span class="pre">list_ndims</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.list_ndims" title="Link to this definition">¶</a></dt> +<dd><p>Returns the number of dimensions of the array.</p> +<p>This is an alias for <a class="reference internal" href="#datafusion.expr.Expr.array_ndims" title="datafusion.expr.Expr.array_ndims"><code class="xref py py-func docutils literal notranslate"><span class="pre">array_ndims()</span></code></a>.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.expr.Expr.literal"> <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">literal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.literal" title="Link to this definition">¶</a></dt> <dd><p>Creates a new expression representing a scalar value.</p> @@ -2136,6 +3329,42 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.ln"> +<span class="sig-name descname"><span class="pre">ln</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.ln" title="Link to this definition">¶</a></dt> +<dd><p>Returns the natural logarithm (base e) of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.log10"> +<span class="sig-name descname"><span class="pre">log10</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.log10" title="Link to this definition">¶</a></dt> +<dd><p>Base 10 logarithm of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.log2"> +<span class="sig-name descname"><span class="pre">log2</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.log2" title="Link to this definition">¶</a></dt> +<dd><p>Base 2 logarithm of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.lower"> +<span class="sig-name descname"><span class="pre">lower</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.lower" title="Link to this definition">¶</a></dt> +<dd><p>Converts a string to lowercase.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.ltrim"> +<span class="sig-name descname"><span class="pre">ltrim</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.ltrim" title="Link to this definition">¶</a></dt> +<dd><p>Removes all characters, spaces by default, from the beginning of a string.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.md5"> +<span class="sig-name descname"><span class="pre">md5</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.md5" title="Link to this definition">¶</a></dt> +<dd><p>Computes an MD5 128-bit checksum for a string expression.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.expr.Expr.null_treatment"> <span class="sig-name descname"><span class="pre">null_treatment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">null_treatment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datafusion.common.NullTreatment</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">ExprFuncBuilder</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.null_treatment" title="Link to this definition">¶</a></dt> <dd><p>Set the treatment for <code class="docutils literal notranslate"><span class="pre">null</span></code> values for a window or aggregate function.</p> @@ -2145,6 +3374,12 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.octet_length"> +<span class="sig-name descname"><span class="pre">octet_length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.octet_length" title="Link to this definition">¶</a></dt> +<dd><p>Returns the number of bytes of a string.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.expr.Expr.order_by"> <span class="sig-name descname"><span class="pre">order_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">exprs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.expr.SortExpr" title="datafusion.expr.SortExpr"><span class="pre">SortExpr</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">ExprFuncBuilder</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.order_by" title="Link to this definition">¶</a></dt> <dd><p>Set the ordering for a window or aggregate function.</p> @@ -2189,6 +3424,18 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.radians"> +<span class="sig-name descname"><span class="pre">radians</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.radians" title="Link to this definition">¶</a></dt> +<dd><p>Converts the argument from degrees to radians.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.reverse"> +<span class="sig-name descname"><span class="pre">reverse</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.reverse" title="Link to this definition">¶</a></dt> +<dd><p>Reverse the string argument.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.expr.Expr.rex_call_operands"> <span class="sig-name descname"><span class="pre">rex_call_operands</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.expr.Expr.rex_call_operands" title="Link to this definition">¶</a></dt> <dd><p>Return the operands of the expression based on it’s variant type.</p> @@ -2214,6 +3461,12 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.rtrim"> +<span class="sig-name descname"><span class="pre">rtrim</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.rtrim" title="Link to this definition">¶</a></dt> +<dd><p>Removes all characters, spaces by default, from the end of a string.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.expr.Expr.schema_name"> <span class="sig-name descname"><span class="pre">schema_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.schema_name" title="Link to this definition">¶</a></dt> <dd><p>Returns the name of this expression as it should appear in a schema.</p> @@ -2221,6 +3474,48 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.sha224"> +<span class="sig-name descname"><span class="pre">sha224</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.sha224" title="Link to this definition">¶</a></dt> +<dd><p>Computes the SHA-224 hash of a binary string.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.sha256"> +<span class="sig-name descname"><span class="pre">sha256</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.sha256" title="Link to this definition">¶</a></dt> +<dd><p>Computes the SHA-256 hash of a binary string.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.sha384"> +<span class="sig-name descname"><span class="pre">sha384</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.sha384" title="Link to this definition">¶</a></dt> +<dd><p>Computes the SHA-384 hash of a binary string.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.sha512"> +<span class="sig-name descname"><span class="pre">sha512</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.sha512" title="Link to this definition">¶</a></dt> +<dd><p>Computes the SHA-512 hash of a binary string.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.signum"> +<span class="sig-name descname"><span class="pre">signum</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.signum" title="Link to this definition">¶</a></dt> +<dd><p>Returns the sign of the argument (-1, 0, +1).</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.sin"> +<span class="sig-name descname"><span class="pre">sin</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.sin" title="Link to this definition">¶</a></dt> +<dd><p>Returns the sine of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.sinh"> +<span class="sig-name descname"><span class="pre">sinh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.sinh" title="Link to this definition">¶</a></dt> +<dd><p>Returns the hyperbolic sine of the argument.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.expr.Expr.sort"> <span class="sig-name descname"><span class="pre">sort</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ascending</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nulls_first</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.SortExpr" title="datafusion.expr.SortExpr"><span class="pre">SortExpr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.sort" title="Link to this definition">¶</a></dt> <dd><p>Creates a sort <a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Expr</span></code></a> from an existing <a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Expr</span></code></a>.</p> @@ -2235,6 +3530,12 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.sqrt"> +<span class="sig-name descname"><span class="pre">sqrt</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.sqrt" title="Link to this definition">¶</a></dt> +<dd><p>Returns the square root of the argument.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.expr.Expr.string_literal"> <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">string_literal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.string_literal" title="Link to this definition">¶</a></dt> <dd><p>Creates a new expression representing a UTF8 literal value.</p> @@ -2246,12 +3547,36 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.tan"> +<span class="sig-name descname"><span class="pre">tan</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.tan" title="Link to this definition">¶</a></dt> +<dd><p>Returns the tangent of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.tanh"> +<span class="sig-name descname"><span class="pre">tanh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.tanh" title="Link to this definition">¶</a></dt> +<dd><p>Returns the hyperbolic tangent of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.to_hex"> +<span class="sig-name descname"><span class="pre">to_hex</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.to_hex" title="Link to this definition">¶</a></dt> +<dd><p>Converts an integer to a hexadecimal string.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.expr.Expr.to_variant"> <span class="sig-name descname"><span class="pre">to_variant</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Any</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.to_variant" title="Link to this definition">¶</a></dt> <dd><p>Convert this expression into a python object if possible.</p> </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.trim"> +<span class="sig-name descname"><span class="pre">trim</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.trim" title="Link to this definition">¶</a></dt> +<dd><p>Removes all characters, spaces by default, from both sides of a string.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.expr.Expr.types"> <span class="sig-name descname"><span class="pre">types</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">datafusion.common.DataTypeMap</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.types" title="Link to this definition">¶</a></dt> <dd><p>Return the <code class="docutils literal notranslate"><span class="pre">DataTypeMap</span></code>.</p> @@ -2264,6 +3589,12 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.expr.Expr.upper"> +<span class="sig-name descname"><span class="pre">upper</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.upper" title="Link to this definition">¶</a></dt> +<dd><p>Converts a string to uppercase.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.expr.Expr.variant_name"> <span class="sig-name descname"><span class="pre">variant_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.variant_name" title="Link to this definition">¶</a></dt> <dd><p>Returns the name of the Expr variant.</p> @@ -2531,6 +3862,41 @@ <dd></dd></dl> <dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.CopyTo"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">CopyTo</span></span><a class="headerlink" href="#datafusion.expr.CopyTo" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.CreateCatalog"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">CreateCatalog</span></span><a class="headerlink" href="#datafusion.expr.CreateCatalog" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.CreateCatalogSchema"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">CreateCatalogSchema</span></span><a class="headerlink" href="#datafusion.expr.CreateCatalogSchema" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.CreateExternalTable"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">CreateExternalTable</span></span><a class="headerlink" href="#datafusion.expr.CreateExternalTable" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.CreateFunction"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">CreateFunction</span></span><a class="headerlink" href="#datafusion.expr.CreateFunction" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.CreateFunctionBody"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">CreateFunctionBody</span></span><a class="headerlink" href="#datafusion.expr.CreateFunctionBody" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.CreateIndex"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">CreateIndex</span></span><a class="headerlink" href="#datafusion.expr.CreateIndex" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> <dt class="sig sig-object py" id="datafusion.expr.CreateMemoryTable"> <span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">CreateMemoryTable</span></span><a class="headerlink" href="#datafusion.expr.CreateMemoryTable" title="Link to this definition">¶</a></dt> <dd></dd></dl> @@ -2541,21 +3907,56 @@ <dd></dd></dl> <dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.Deallocate"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Deallocate</span></span><a class="headerlink" href="#datafusion.expr.Deallocate" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.DescribeTable"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">DescribeTable</span></span><a class="headerlink" href="#datafusion.expr.DescribeTable" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> <dt class="sig sig-object py" id="datafusion.expr.Distinct"> <span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Distinct</span></span><a class="headerlink" href="#datafusion.expr.Distinct" title="Link to this definition">¶</a></dt> <dd></dd></dl> <dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.DmlStatement"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">DmlStatement</span></span><a class="headerlink" href="#datafusion.expr.DmlStatement" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.DropCatalogSchema"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">DropCatalogSchema</span></span><a class="headerlink" href="#datafusion.expr.DropCatalogSchema" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.DropFunction"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">DropFunction</span></span><a class="headerlink" href="#datafusion.expr.DropFunction" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> <dt class="sig sig-object py" id="datafusion.expr.DropTable"> <span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">DropTable</span></span><a class="headerlink" href="#datafusion.expr.DropTable" title="Link to this definition">¶</a></dt> <dd></dd></dl> <dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.DropView"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">DropView</span></span><a class="headerlink" href="#datafusion.expr.DropView" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> <dt class="sig sig-object py" id="datafusion.expr.EmptyRelation"> <span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">EmptyRelation</span></span><a class="headerlink" href="#datafusion.expr.EmptyRelation" title="Link to this definition">¶</a></dt> <dd></dd></dl> <dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.Execute"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Execute</span></span><a class="headerlink" href="#datafusion.expr.Execute" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> <dt class="sig sig-object py" id="datafusion.expr.Exists"> <span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Exists</span></span><a class="headerlink" href="#datafusion.expr.Exists" title="Link to this definition">¶</a></dt> <dd></dd></dl> @@ -2571,6 +3972,11 @@ <dd></dd></dl> <dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.FileType"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">FileType</span></span><a class="headerlink" href="#datafusion.expr.FileType" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> <dt class="sig sig-object py" id="datafusion.expr.Filter"> <span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Filter</span></span><a class="headerlink" href="#datafusion.expr.Filter" title="Link to this definition">¶</a></dt> <dd></dd></dl> @@ -2676,6 +4082,11 @@ <dd></dd></dl> <dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.OperateFunctionArg"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">OperateFunctionArg</span></span><a class="headerlink" href="#datafusion.expr.OperateFunctionArg" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> <dt class="sig sig-object py" id="datafusion.expr.Partitioning"> <span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Partitioning</span></span><a class="headerlink" href="#datafusion.expr.Partitioning" title="Link to this definition">¶</a></dt> <dd></dd></dl> @@ -2686,11 +4097,21 @@ <dd></dd></dl> <dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.Prepare"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Prepare</span></span><a class="headerlink" href="#datafusion.expr.Prepare" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> <dt class="sig sig-object py" id="datafusion.expr.Projection"> <span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Projection</span></span><a class="headerlink" href="#datafusion.expr.Projection" title="Link to this definition">¶</a></dt> <dd></dd></dl> <dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.RecursiveQuery"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">RecursiveQuery</span></span><a class="headerlink" href="#datafusion.expr.RecursiveQuery" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> <dt class="sig sig-object py" id="datafusion.expr.Repartition"> <span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Repartition</span></span><a class="headerlink" href="#datafusion.expr.Repartition" title="Link to this definition">¶</a></dt> <dd></dd></dl> @@ -2706,6 +4127,11 @@ <dd></dd></dl> <dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.SetVariable"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">SetVariable</span></span><a class="headerlink" href="#datafusion.expr.SetVariable" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> <dt class="sig sig-object py" id="datafusion.expr.SimilarTo"> <span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">SimilarTo</span></span><a class="headerlink" href="#datafusion.expr.SimilarTo" title="Link to this definition">¶</a></dt> <dd></dd></dl> @@ -2731,6 +4157,31 @@ <dd></dd></dl> <dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.TransactionAccessMode"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">TransactionAccessMode</span></span><a class="headerlink" href="#datafusion.expr.TransactionAccessMode" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.TransactionConclusion"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">TransactionConclusion</span></span><a class="headerlink" href="#datafusion.expr.TransactionConclusion" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.TransactionEnd"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">TransactionEnd</span></span><a class="headerlink" href="#datafusion.expr.TransactionEnd" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.TransactionIsolationLevel"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">TransactionIsolationLevel</span></span><a class="headerlink" href="#datafusion.expr.TransactionIsolationLevel" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.TransactionStart"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">TransactionStart</span></span><a class="headerlink" href="#datafusion.expr.TransactionStart" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> <dt class="sig sig-object py" id="datafusion.expr.TryCast"> <span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">TryCast</span></span><a class="headerlink" href="#datafusion.expr.TryCast" title="Link to this definition">¶</a></dt> <dd></dd></dl> @@ -2751,6 +4202,11 @@ <dd></dd></dl> <dl class="py data"> +<dt class="sig sig-object py" id="datafusion.expr.Values"> +<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Values</span></span><a class="headerlink" href="#datafusion.expr.Values" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> <dt class="sig sig-object py" id="datafusion.expr.WindowExpr"> <span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">WindowExpr</span></span><a class="headerlink" href="#datafusion.expr.WindowExpr" title="Link to this definition">¶</a></dt> <dd></dd></dl>
diff --git a/autoapi/datafusion/functions/index.html b/autoapi/datafusion/functions/index.html index 05ced22..16accb2 100644 --- a/autoapi/datafusion/functions/index.html +++ b/autoapi/datafusion/functions/index.html
@@ -34,7 +34,7 @@ <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script> <link rel="index" title="Index" href="../../../genindex.html" /> <link rel="search" title="Search" href="../../../search.html" /> - <link rel="next" title="datafusion.input" href="../input/index.html" /> + <link rel="next" title="datafusion.html_formatter" href="../html_formatter/index.html" /> <link rel="prev" title="datafusion.expr" href="../expr/index.html" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="docsearch:language" content="en"> @@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../user-guide/common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul> @@ -2594,7 +2619,7 @@ <td><p>Returns inverse hyperbolic cosine.</p></td> </tr> <tr class="row-even"><td><p><a class="reference internal" href="#datafusion.functions.alias" title="datafusion.functions.alias"><code class="xref py py-obj docutils literal notranslate"><span class="pre">alias</span></code></a>(→ datafusion.expr.Expr)</p></td> -<td><p>Creates an alias expression.</p></td> +<td><p>Creates an alias expression with an optional metadata dictionary.</p></td> </tr> <tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.functions.approx_distinct" title="datafusion.functions.approx_distinct"><code class="xref py py-obj docutils literal notranslate"><span class="pre">approx_distinct</span></code></a>(→ datafusion.expr.Expr)</p></td> <td><p>Returns the approximate number of distinct values.</p></td> @@ -3346,8 +3371,20 @@ <dl class="py function"> <dt class="sig sig-object py" id="datafusion.functions.alias"> -<span class="sig-prename descclassname"><span class="pre">datafusion.functions.</span></span><span class="sig-name descname"><span class="pre">alias</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">expr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a></span></span><a class="headerlink" href="#datafusion.functions.alias" title="Link to this definition">¶</a></dt> -<dd><p>Creates an alias expression.</p> +<span class="sig-prename descclassname"><span class="pre">datafusion.functions.</span></span><span class="sig-name descname"><span class="pre">alias</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">expr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a></span></span><a class="headerlink" href="#datafusion.functions.alias" title="Link to this definition">¶</a></dt> +<dd><p>Creates an alias expression with an optional metadata dictionary.</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>expr</strong> – The expression to alias</p></li> +<li><p><strong>name</strong> – The alias name</p></li> +<li><p><strong>metadata</strong> – Optional metadata to attach to the column</p></li> +</ul> +</dd> +<dt class="field-even">Returns<span class="colon">:</span></dt> +<dd class="field-even"><p>An expression with the given alias</p> +</dd> +</dl> </dd></dl> <dl class="py function"> @@ -5555,10 +5592,10 @@ <p class="prev-next-title">datafusion.expr</p> </div> </a> - <a class='right-next' id="next-link" href="../input/index.html" title="next page"> + <a class='right-next' id="next-link" href="../html_formatter/index.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> - <p class="prev-next-title">datafusion.input</p> + <p class="prev-next-title">datafusion.html_formatter</p> </div> <i class="fas fa-angle-right"></i> </a>
diff --git a/autoapi/datafusion/html_formatter/index.html b/autoapi/datafusion/html_formatter/index.html new file mode 100644 index 0000000..53292c6 --- /dev/null +++ b/autoapi/datafusion/html_formatter/index.html
@@ -0,0 +1,1560 @@ +<!DOCTYPE html> + +<html lang="en" data-content_root="../../../"> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> + + <title>datafusion.html_formatter — Apache Arrow DataFusion documentation</title> + + <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> +<link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> + + + <link rel="stylesheet" + href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> + <link rel="preload" as="font" type="font/woff2" crossorigin + href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> + <link rel="preload" as="font" type="font/woff2" crossorigin + href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> + + + + + + <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=8f2a1f02" /> + <link rel="stylesheet" type="text/css" href="../../../_static/styles/pydata-sphinx-theme.css?v=1140d252" /> + <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=4ae1632d" /> + <link rel="stylesheet" type="text/css" href="../../../_static/theme_overrides.css?v=dca7052a" /> + + <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> + + <script src="../../../_static/documentation_options.js?v=8a448e45"></script> + <script src="../../../_static/doctools.js?v=9bcbadda"></script> + <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="datafusion.input" href="../input/index.html" /> + <link rel="prev" title="datafusion.functions" href="../functions/index.html" /> + <meta name="viewport" content="width=device-width, initial-scale=1" /> + <meta name="docsearch:language" content="en"> + + + <!-- Google Analytics --> + + </head> + <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80"> + + <div class="container-fluid" id="banner"></div> + + + + + <div class="container-xl"> + <div class="row"> + + + <!-- Only show if we have sidebars configured, else just a small margin --> + <div class="col-12 col-md-3 bd-sidebar"> + <div class="sidebar-start-items"> +<a class="navbar-brand" href="../../../index.html"> + <img src="../../../_static/images/2x_bgwhite_original.png" class="logo" alt="logo"> +</a> + +<form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> + <i class="icon fas fa-search"></i> + <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" > +</form> + +<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation"> + <div class="bd-toc-item active"> + + <p aria-level="2" class="caption" role="heading"> + <span class="caption-text"> + LINKS + </span> +</p> +<ul class="nav bd-sidenav"> + <li class="toctree-l1"> + <a class="reference external" href="https://github.com/apache/datafusion-python"> + Github and Issue Tracker + </a> + </li> + <li class="toctree-l1"> + <a class="reference external" href="https://docs.rs/datafusion/latest/datafusion/"> + Rust's API Docs + </a> + </li> + <li class="toctree-l1"> + <a class="reference external" href="https://github.com/apache/datafusion/blob/main/CODE_OF_CONDUCT.md"> + Code of conduct + </a> + </li> + <li class="toctree-l1"> + <a class="reference external" href="https://github.com/apache/datafusion-python/tree/main/examples"> + Examples + </a> + </li> +</ul> +<p aria-level="2" class="caption" role="heading"> + <span class="caption-text"> + USER GUIDE + </span> +</p> +<ul class="nav bd-sidenav"> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/introduction.html"> + Introduction + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/basics.html"> + Concepts + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/data-sources.html"> + Data Sources + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/dataframe.html"> + DataFrames + </a> + </li> + <li class="toctree-l1 has-children"> + <a class="reference internal" href="../../../user-guide/common-operations/index.html"> + Common Operations + </a> + <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/> + <label for="toctree-checkbox-1"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/views.html"> + Registering Views + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/basic-info.html"> + Basic Operations + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/select-and-filter.html"> + Column Selections + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/expressions.html"> + Expressions + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/joins.html"> + Joins + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/functions.html"> + Functions + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/aggregations.html"> + Aggregation + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/windows.html"> + Window Functions + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/udf-and-udfa.html"> + User-Defined Functions + </a> + </li> + </ul> + </li> + <li class="toctree-l1 has-children"> + <a class="reference internal" href="../../../user-guide/io/index.html"> + IO + </a> + <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/> + <label for="toctree-checkbox-2"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/arrow.html"> + Arrow + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/avro.html"> + Avro + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/csv.html"> + CSV + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/json.html"> + JSON + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/parquet.html"> + Parquet + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/table_provider.html"> + Custom Table Provider + </a> + </li> + </ul> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/configuration.html"> + Configuration + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/sql.html"> + SQL + </a> + </li> +</ul> +<p aria-level="2" class="caption" role="heading"> + <span class="caption-text"> + CONTRIBUTOR GUIDE + </span> +</p> +<ul class="nav bd-sidenav"> + <li class="toctree-l1"> + <a class="reference internal" href="../../../contributor-guide/introduction.html"> + Introduction + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../contributor-guide/ffi.html"> + Python Extensions + </a> + </li> +</ul> +<p aria-level="2" class="caption" role="heading"> + <span class="caption-text"> + API + </span> +</p> +<ul class="current nav bd-sidenav"> + <li class="toctree-l1 current active has-children"> + <a class="reference internal" href="../../index.html"> + API Reference + </a> + <input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/> + <label for="toctree-checkbox-3"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul class="current"> + <li class="toctree-l2 current active has-children"> + <a class="reference internal" href="../index.html"> + datafusion + </a> + <input checked="" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/> + <label for="toctree-checkbox-4"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul class="current"> + <li class="toctree-l3"> + <a class="reference internal" href="../catalog/index.html"> + datafusion.catalog + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../context/index.html"> + datafusion.context + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../dataframe/index.html"> + datafusion.dataframe + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../expr/index.html"> + datafusion.expr + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../functions/index.html"> + datafusion.functions + </a> + </li> + <li class="toctree-l3 current active"> + <a class="current reference internal" href="#"> + datafusion.html_formatter + </a> + </li> + <li class="toctree-l3 has-children"> + <a class="reference internal" href="../input/index.html"> + datafusion.input + </a> + <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/> + <label for="toctree-checkbox-5"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul> + <li class="toctree-l4"> + <a class="reference internal" href="../input/base/index.html"> + datafusion.input.base + </a> + </li> + <li class="toctree-l4"> + <a class="reference internal" href="../input/location/index.html"> + datafusion.input.location + </a> + </li> + </ul> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../io/index.html"> + datafusion.io + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../object_store/index.html"> + datafusion.object_store + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../plan/index.html"> + datafusion.plan + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../record_batch/index.html"> + datafusion.record_batch + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../substrait/index.html"> + datafusion.substrait + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../udf/index.html"> + datafusion.udf + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../user_defined/index.html"> + datafusion.user_defined + </a> + </li> + </ul> + </li> + </ul> + </li> +</ul> + + + </div> +</nav> + </div> + <div class="sidebar-end-items"> + </div> + </div> + + + + + <div class="d-none d-xl-block col-xl-2 bd-toc"> + + + <div class="toc-item"> + +<div class="tocsection onthispage pt-5 pb-3"> + <i class="fas fa-list"></i> On this page +</div> + +<nav id="bd-toc-nav"> + <ul class="visible nav section-nav flex-column"> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#classes"> + Classes + </a> + </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#functions"> + Functions + </a> + </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#module-contents"> + Module Contents + </a> + <ul class="visible nav section-nav flex-column"> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.CellFormatter"> + <code class="docutils literal notranslate"> + <span class="pre"> + CellFormatter + </span> + </code> + </a> + <ul class="nav section-nav flex-column"> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.CellFormatter.__call__"> + <code class="docutils literal notranslate"> + <span class="pre"> + CellFormatter.__call__() + </span> + </code> + </a> + </li> + </ul> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter + </span> + </code> + </a> + <ul class="nav section-nav flex-column"> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter._build_expandable_cell"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter._build_expandable_cell() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter._build_html_footer"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter._build_html_footer() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter._build_html_header"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter._build_html_header() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter._build_regular_cell"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter._build_regular_cell() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter._build_table_body"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter._build_table_body() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter._build_table_container_start"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter._build_table_container_start() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter._build_table_header"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter._build_table_header() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter._format_cell_value"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter._format_cell_value() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter._get_cell_value"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter._get_cell_value() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter._get_default_css"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter._get_default_css() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter._get_javascript"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter._get_javascript() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter.format_html"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter.format_html() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter.is_styles_loaded"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter.is_styles_loaded() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter.register_formatter"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter.register_formatter() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter.set_custom_cell_builder"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter.set_custom_cell_builder() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter.set_custom_header_builder"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter.set_custom_header_builder() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter._custom_cell_builder"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter._custom_cell_builder + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter._custom_header_builder"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter._custom_header_builder + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter._styles_loaded"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter._styles_loaded + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter._type_formatters"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter._type_formatters + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter.custom_css"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter.custom_css + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter.enable_cell_expansion"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter.enable_cell_expansion + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter.max_cell_length"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter.max_cell_length + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter.max_height"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter.max_height + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter.max_memory_bytes"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter.max_memory_bytes + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter.max_width"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter.max_width + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter.min_rows_display"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter.min_rows_display + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter.repr_rows"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter.repr_rows + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter.show_truncation_message"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter.show_truncation_message + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter.style_provider"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter.style_provider + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DataFrameHtmlFormatter.use_shared_styles"> + <code class="docutils literal notranslate"> + <span class="pre"> + DataFrameHtmlFormatter.use_shared_styles + </span> + </code> + </a> + </li> + </ul> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DefaultStyleProvider"> + <code class="docutils literal notranslate"> + <span class="pre"> + DefaultStyleProvider + </span> + </code> + </a> + <ul class="nav section-nav flex-column"> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DefaultStyleProvider.get_cell_style"> + <code class="docutils literal notranslate"> + <span class="pre"> + DefaultStyleProvider.get_cell_style() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.DefaultStyleProvider.get_header_style"> + <code class="docutils literal notranslate"> + <span class="pre"> + DefaultStyleProvider.get_header_style() + </span> + </code> + </a> + </li> + </ul> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.FormatterManager"> + <code class="docutils literal notranslate"> + <span class="pre"> + FormatterManager + </span> + </code> + </a> + <ul class="nav section-nav flex-column"> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.FormatterManager.get_formatter"> + <code class="docutils literal notranslate"> + <span class="pre"> + FormatterManager.get_formatter() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.FormatterManager.set_formatter"> + <code class="docutils literal notranslate"> + <span class="pre"> + FormatterManager.set_formatter() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.FormatterManager._default_formatter"> + <code class="docutils literal notranslate"> + <span class="pre"> + FormatterManager._default_formatter + </span> + </code> + </a> + </li> + </ul> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.StyleProvider"> + <code class="docutils literal notranslate"> + <span class="pre"> + StyleProvider + </span> + </code> + </a> + <ul class="nav section-nav flex-column"> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.StyleProvider.get_cell_style"> + <code class="docutils literal notranslate"> + <span class="pre"> + StyleProvider.get_cell_style() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.StyleProvider.get_header_style"> + <code class="docutils literal notranslate"> + <span class="pre"> + StyleProvider.get_header_style() + </span> + </code> + </a> + </li> + </ul> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter._refresh_formatter_reference"> + <code class="docutils literal notranslate"> + <span class="pre"> + _refresh_formatter_reference() + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter._validate_bool"> + <code class="docutils literal notranslate"> + <span class="pre"> + _validate_bool() + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter._validate_positive_int"> + <code class="docutils literal notranslate"> + <span class="pre"> + _validate_positive_int() + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.configure_formatter"> + <code class="docutils literal notranslate"> + <span class="pre"> + configure_formatter() + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.get_formatter"> + <code class="docutils literal notranslate"> + <span class="pre"> + get_formatter() + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.reset_formatter"> + <code class="docutils literal notranslate"> + <span class="pre"> + reset_formatter() + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.reset_styles_loaded_state"> + <code class="docutils literal notranslate"> + <span class="pre"> + reset_styles_loaded_state() + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.html_formatter.set_formatter"> + <code class="docutils literal notranslate"> + <span class="pre"> + set_formatter() + </span> + </code> + </a> + </li> + </ul> + </li> +</ul> + +</nav> + </div> + + <div class="toc-item"> + + </div> + + + </div> + + + + + + + <main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main"> + + <div> + + <section id="module-datafusion.html_formatter"> +<span id="datafusion-html-formatter"></span><h1>datafusion.html_formatter<a class="headerlink" href="#module-datafusion.html_formatter" title="Link to this heading">¶</a></h1> +<p>HTML formatting utilities for DataFusion DataFrames.</p> +<section id="classes"> +<h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶</a></h2> +<table class="autosummary longtable table autosummary"> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.html_formatter.CellFormatter" title="datafusion.html_formatter.CellFormatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CellFormatter</span></code></a></p></td> +<td><p>Protocol for cell value formatters.</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.html_formatter.DataFrameHtmlFormatter" title="datafusion.html_formatter.DataFrameHtmlFormatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrameHtmlFormatter</span></code></a></p></td> +<td><p>Configurable HTML formatter for DataFusion DataFrames.</p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.html_formatter.DefaultStyleProvider" title="datafusion.html_formatter.DefaultStyleProvider"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DefaultStyleProvider</span></code></a></p></td> +<td><p>Default implementation of StyleProvider.</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.html_formatter.FormatterManager" title="datafusion.html_formatter.FormatterManager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FormatterManager</span></code></a></p></td> +<td><p>Manager class for the global DataFrame HTML formatter instance.</p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.html_formatter.StyleProvider" title="datafusion.html_formatter.StyleProvider"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StyleProvider</span></code></a></p></td> +<td><p>Protocol for HTML style providers.</p></td> +</tr> +</tbody> +</table> +</section> +<section id="functions"> +<h2>Functions<a class="headerlink" href="#functions" title="Link to this heading">¶</a></h2> +<table class="autosummary longtable table autosummary"> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.html_formatter._refresh_formatter_reference" title="datafusion.html_formatter._refresh_formatter_reference"><code class="xref py py-obj docutils literal notranslate"><span class="pre">_refresh_formatter_reference</span></code></a>(→ None)</p></td> +<td><p>Refresh formatter reference in any modules using it.</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.html_formatter._validate_bool" title="datafusion.html_formatter._validate_bool"><code class="xref py py-obj docutils literal notranslate"><span class="pre">_validate_bool</span></code></a>(→ None)</p></td> +<td><p>Validate that a parameter is a boolean.</p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.html_formatter._validate_positive_int" title="datafusion.html_formatter._validate_positive_int"><code class="xref py py-obj docutils literal notranslate"><span class="pre">_validate_positive_int</span></code></a>(→ None)</p></td> +<td><p>Validate that a parameter is a positive integer.</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.html_formatter.configure_formatter" title="datafusion.html_formatter.configure_formatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">configure_formatter</span></code></a>(→ None)</p></td> +<td><p>Configure the global DataFrame HTML formatter.</p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.html_formatter.get_formatter" title="datafusion.html_formatter.get_formatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_formatter</span></code></a>(→ DataFrameHtmlFormatter)</p></td> +<td><p>Get the current global DataFrame HTML formatter.</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.html_formatter.reset_formatter" title="datafusion.html_formatter.reset_formatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset_formatter</span></code></a>(→ None)</p></td> +<td><p>Reset the global DataFrame HTML formatter to default settings.</p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.html_formatter.reset_styles_loaded_state" title="datafusion.html_formatter.reset_styles_loaded_state"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset_styles_loaded_state</span></code></a>(→ None)</p></td> +<td><p>Reset the styles loaded state to force reloading of styles.</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.html_formatter.set_formatter" title="datafusion.html_formatter.set_formatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_formatter</span></code></a>(→ None)</p></td> +<td><p>Set the global DataFrame HTML formatter.</p></td> +</tr> +</tbody> +</table> +</section> +<section id="module-contents"> +<h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to this heading">¶</a></h2> +<dl class="py class"> +<dt class="sig sig-object py" id="datafusion.html_formatter.CellFormatter"> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.html_formatter.</span></span><span class="sig-name descname"><span class="pre">CellFormatter</span></span><a class="headerlink" href="#datafusion.html_formatter.CellFormatter" title="Link to this definition">¶</a></dt> +<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">Protocol</span></code></p> +<p>Protocol for cell value formatters.</p> +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.CellFormatter.__call__"> +<span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.html_formatter.CellFormatter.__call__" title="Link to this definition">¶</a></dt> +<dd><p>Format a cell value to string representation.</p> +</dd></dl> + +</dd></dl> + +<dl class="py class"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter"> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.html_formatter.</span></span><span class="sig-name descname"><span class="pre">DataFrameHtmlFormatter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_cell_length</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">25</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_width</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_height</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">300</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_memory_bytes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">2</span> <span class="pre">*</span> <span class="pre">1024</span> <span class="pre">*</span> <span class="pre">1024</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_rows_display</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">20</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">repr_rows</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enable_cell_expansion</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_css</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_truncation_message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style_provider</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.html_formatter.StyleProvider" title="datafusion.html_formatter.StyleProvider"><span class="pre">StyleProvider</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_shared_styles</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter" title="Link to this definition">¶</a></dt> +<dd><p>Configurable HTML formatter for DataFusion DataFrames.</p> +<p>This class handles the HTML rendering of DataFrames for display in +Jupyter notebooks and other rich display contexts.</p> +<p>This class supports extension through composition. Key extension points: +- Provide a custom StyleProvider for styling cells and headers +- Register custom formatters for specific types +- Provide custom cell builders for specialized cell rendering</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>max_cell_length</strong> – Maximum characters to display in a cell before truncation</p></li> +<li><p><strong>max_width</strong> – Maximum width of the HTML table in pixels</p></li> +<li><p><strong>max_height</strong> – Maximum height of the HTML table in pixels</p></li> +<li><p><strong>max_memory_bytes</strong> – Maximum memory in bytes for rendered data (default: 2MB)</p></li> +<li><p><strong>min_rows_display</strong> – Minimum number of rows to display</p></li> +<li><p><strong>repr_rows</strong> – Default number of rows to display in repr output</p></li> +<li><p><strong>enable_cell_expansion</strong> – Whether to add expand/collapse buttons for long cell +values</p></li> +<li><p><strong>custom_css</strong> – Additional CSS to include in the HTML output</p></li> +<li><p><strong>show_truncation_message</strong> – Whether to display a message when data is truncated</p></li> +<li><p><strong>style_provider</strong> – Custom provider for cell and header styles</p></li> +<li><p><strong>use_shared_styles</strong> – Whether to load styles and scripts only once per notebook +session</p></li> +</ul> +</dd> +</dl> +<p>Initialize the HTML formatter.</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>max_cell_length</strong> (<em>int</em><em>, </em><em>default 25</em>) – Maximum length of cell content before truncation.</p></li> +<li><p><strong>max_width</strong> (<em>int</em><em>, </em><em>default 1000</em>) – Maximum width of the displayed table in pixels.</p></li> +<li><p><strong>max_height</strong> (<em>int</em><em>, </em><em>default 300</em>) – Maximum height of the displayed table in pixels.</p></li> +<li><p><strong>max_memory_bytes</strong> (<em>int</em><em>, </em><em>default 2097152</em><em> (</em><em>2MB</em><em>)</em>) – Maximum memory in bytes for rendered data.</p></li> +<li><p><strong>min_rows_display</strong> (<em>int</em><em>, </em><em>default 20</em>) – Minimum number of rows to display.</p></li> +<li><p><strong>repr_rows</strong> (<em>int</em><em>, </em><em>default 10</em>) – Default number of rows to display in repr output.</p></li> +<li><p><strong>enable_cell_expansion</strong> (<em>bool</em><em>, </em><em>default True</em>) – Whether to allow cells to expand when clicked.</p></li> +<li><p><strong>custom_css</strong> (<em>str</em><em>, </em><em>optional</em>) – Custom CSS to apply to the HTML table.</p></li> +<li><p><strong>show_truncation_message</strong> (<em>bool</em><em>, </em><em>default True</em>) – Whether to show a message indicating that content has been truncated.</p></li> +<li><p><strong>style_provider</strong> (<a class="reference internal" href="#datafusion.html_formatter.StyleProvider" title="datafusion.html_formatter.StyleProvider"><em>StyleProvider</em></a><em>, </em><em>optional</em>) – Provider of CSS styles for the HTML table. If None, DefaultStyleProvider +is used.</p></li> +<li><p><strong>use_shared_styles</strong> (<em>bool</em><em>, </em><em>default True</em>) – Whether to use shared styles across multiple tables.</p></li> +<li><p><strong>Raises</strong></p></li> +<li><p><strong>------</strong></p></li> +<li><p><strong>ValueError</strong> – If max_cell_length, max_width, max_height, max_memory_bytes, +min_rows_display, or repr_rows is not a positive integer.</p></li> +<li><p><strong>TypeError</strong> – If enable_cell_expansion, show_truncation_message, or use_shared_styles is +not a boolean, +or if custom_css is provided but is not a string, +or if style_provider is provided but does not implement the StyleProvider +protocol.</p></li> +</ul> +</dd> +</dl> +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter._build_expandable_cell"> +<span class="sig-name descname"><span class="pre">_build_expandable_cell</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">formatted_value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">row_count</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">col_idx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">table_uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter._build_expandable_cell" title="Link to this definition">¶</a></dt> +<dd><p>Build an expandable cell for long content.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter._build_html_footer"> +<span class="sig-name descname"><span class="pre">_build_html_footer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">has_more</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter._build_html_footer" title="Link to this definition">¶</a></dt> +<dd><p>Build the HTML footer with JavaScript and messages.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter._build_html_header"> +<span class="sig-name descname"><span class="pre">_build_html_header</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter._build_html_header" title="Link to this definition">¶</a></dt> +<dd><p>Build the HTML header with CSS styles.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter._build_regular_cell"> +<span class="sig-name descname"><span class="pre">_build_regular_cell</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">formatted_value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter._build_regular_cell" title="Link to this definition">¶</a></dt> +<dd><p>Build a regular table cell.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter._build_table_body"> +<span class="sig-name descname"><span class="pre">_build_table_body</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">batches</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">table_uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter._build_table_body" title="Link to this definition">¶</a></dt> +<dd><p>Build the HTML table body with data rows.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter._build_table_container_start"> +<span class="sig-name descname"><span class="pre">_build_table_container_start</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter._build_table_container_start" title="Link to this definition">¶</a></dt> +<dd><p>Build the opening tags for the table container.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter._build_table_header"> +<span class="sig-name descname"><span class="pre">_build_table_header</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">schema</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter._build_table_header" title="Link to this definition">¶</a></dt> +<dd><p>Build the HTML table header with column names.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter._format_cell_value"> +<span class="sig-name descname"><span class="pre">_format_cell_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter._format_cell_value" title="Link to this definition">¶</a></dt> +<dd><p>Format a cell value for display.</p> +<p>Uses registered type formatters if available.</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><p><strong>value</strong> – The cell value to format</p> +</dd> +<dt class="field-even">Returns<span class="colon">:</span></dt> +<dd class="field-even"><p>Formatted cell value as string</p> +</dd> +</dl> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter._get_cell_value"> +<span class="sig-name descname"><span class="pre">_get_cell_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">column</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">row_idx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Any</span></span></span><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter._get_cell_value" title="Link to this definition">¶</a></dt> +<dd><p>Extract a cell value from a column.</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>column</strong> – Arrow array</p></li> +<li><p><strong>row_idx</strong> – Row index</p></li> +</ul> +</dd> +<dt class="field-even">Returns<span class="colon">:</span></dt> +<dd class="field-even"><p>The raw cell value</p> +</dd> +</dl> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter._get_default_css"> +<span class="sig-name descname"><span class="pre">_get_default_css</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter._get_default_css" title="Link to this definition">¶</a></dt> +<dd><p>Get default CSS styles for the HTML table.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter._get_javascript"> +<span class="sig-name descname"><span class="pre">_get_javascript</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter._get_javascript" title="Link to this definition">¶</a></dt> +<dd><p>Get JavaScript code for interactive elements.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter.format_html"> +<span class="sig-name descname"><span class="pre">format_html</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">batches</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schema</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">has_more</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">table_uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter.format_html" title="Link to this definition">¶</a></dt> +<dd><p>Format record batches as HTML.</p> +<p>This method is used by DataFrame’s _repr_html_ implementation and can be +called directly when custom HTML rendering is needed.</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>batches</strong> – List of Arrow RecordBatch objects</p></li> +<li><p><strong>schema</strong> – Arrow Schema object</p></li> +<li><p><strong>has_more</strong> – Whether there are more batches not shown</p></li> +<li><p><strong>table_uuid</strong> – Unique ID for the table, used for JavaScript interactions</p></li> +</ul> +</dd> +<dt class="field-even">Returns<span class="colon">:</span></dt> +<dd class="field-even"><p>HTML string representation of the data</p> +</dd> +<dt class="field-odd">Raises<span class="colon">:</span></dt> +<dd class="field-odd"><p><strong>TypeError</strong> – If schema is invalid and no batches are provided</p> +</dd> +</dl> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter.is_styles_loaded"> +<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_styles_loaded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter.is_styles_loaded" title="Link to this definition">¶</a></dt> +<dd><p>Check if HTML styles have been loaded in the current session.</p> +<p>This method is primarily intended for debugging UI rendering issues +related to style loading.</p> +<dl class="field-list simple"> +<dt class="field-odd">Returns<span class="colon">:</span></dt> +<dd class="field-odd"><p>True if styles have been loaded, False otherwise</p> +</dd> +</dl> +<p class="rubric">Example</p> +<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datafusion.html_formatter</span><span class="w"> </span><span class="kn">import</span> <span class="n">DataFrameHtmlFormatter</span> +<span class="gp">>>> </span><span class="n">DataFrameHtmlFormatter</span><span class="o">.</span><span class="n">is_styles_loaded</span><span class="p">()</span> +<span class="go">False</span> +</pre></div> +</div> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter.register_formatter"> +<span class="sig-name descname"><span class="pre">register_formatter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type_class</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">formatter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.html_formatter.CellFormatter" title="datafusion.html_formatter.CellFormatter"><span class="pre">CellFormatter</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter.register_formatter" title="Link to this definition">¶</a></dt> +<dd><p>Register a custom formatter for a specific data type.</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>type_class</strong> – The type to register a formatter for</p></li> +<li><p><strong>formatter</strong> – Function that takes a value of the given type and returns +a formatted string</p></li> +</ul> +</dd> +</dl> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter.set_custom_cell_builder"> +<span class="sig-name descname"><span class="pre">set_custom_cell_builder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">builder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter.set_custom_cell_builder" title="Link to this definition">¶</a></dt> +<dd><p>Set a custom cell builder function.</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><p><strong>builder</strong> – Function that takes (value, row, col, table_id) and returns HTML</p> +</dd> +</dl> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter.set_custom_header_builder"> +<span class="sig-name descname"><span class="pre">set_custom_header_builder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">builder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter.set_custom_header_builder" title="Link to this definition">¶</a></dt> +<dd><p>Set a custom header builder function.</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><p><strong>builder</strong> – Function that takes a field and returns HTML</p> +</dd> +</dl> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter._custom_cell_builder"> +<span class="sig-name descname"><span class="pre">_custom_cell_builder</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter._custom_cell_builder" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter._custom_header_builder"> +<span class="sig-name descname"><span class="pre">_custom_header_builder</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter._custom_header_builder" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter._styles_loaded"> +<span class="sig-name descname"><span class="pre">_styles_loaded</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter._styles_loaded" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter._type_formatters"> +<span class="sig-name descname"><span class="pre">_type_formatters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.html_formatter.CellFormatter" title="datafusion.html_formatter.CellFormatter"><span class="pre">CellFormatter</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter._type_formatters" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter.custom_css"> +<span class="sig-name descname"><span class="pre">custom_css</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter.custom_css" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter.enable_cell_expansion"> +<span class="sig-name descname"><span class="pre">enable_cell_expansion</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter.enable_cell_expansion" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter.max_cell_length"> +<span class="sig-name descname"><span class="pre">max_cell_length</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">25</span></em><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter.max_cell_length" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter.max_height"> +<span class="sig-name descname"><span class="pre">max_height</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">300</span></em><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter.max_height" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter.max_memory_bytes"> +<span class="sig-name descname"><span class="pre">max_memory_bytes</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2097152</span></em><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter.max_memory_bytes" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter.max_width"> +<span class="sig-name descname"><span class="pre">max_width</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1000</span></em><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter.max_width" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter.min_rows_display"> +<span class="sig-name descname"><span class="pre">min_rows_display</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">20</span></em><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter.min_rows_display" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter.repr_rows"> +<span class="sig-name descname"><span class="pre">repr_rows</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></em><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter.repr_rows" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter.show_truncation_message"> +<span class="sig-name descname"><span class="pre">show_truncation_message</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter.show_truncation_message" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter.style_provider"> +<span class="sig-name descname"><span class="pre">style_provider</span></span><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter.style_provider" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DataFrameHtmlFormatter.use_shared_styles"> +<span class="sig-name descname"><span class="pre">use_shared_styles</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#datafusion.html_formatter.DataFrameHtmlFormatter.use_shared_styles" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +</dd></dl> + +<dl class="py class"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DefaultStyleProvider"> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.html_formatter.</span></span><span class="sig-name descname"><span class="pre">DefaultStyleProvider</span></span><a class="headerlink" href="#datafusion.html_formatter.DefaultStyleProvider" title="Link to this definition">¶</a></dt> +<dd><p>Default implementation of StyleProvider.</p> +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DefaultStyleProvider.get_cell_style"> +<span class="sig-name descname"><span class="pre">get_cell_style</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.html_formatter.DefaultStyleProvider.get_cell_style" title="Link to this definition">¶</a></dt> +<dd><p>Get the CSS style for table cells.</p> +<dl class="field-list simple"> +<dt class="field-odd">Returns<span class="colon">:</span></dt> +<dd class="field-odd"><p>CSS style string</p> +</dd> +</dl> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.DefaultStyleProvider.get_header_style"> +<span class="sig-name descname"><span class="pre">get_header_style</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.html_formatter.DefaultStyleProvider.get_header_style" title="Link to this definition">¶</a></dt> +<dd><p>Get the CSS style for header cells.</p> +<dl class="field-list simple"> +<dt class="field-odd">Returns<span class="colon">:</span></dt> +<dd class="field-odd"><p>CSS style string</p> +</dd> +</dl> +</dd></dl> + +</dd></dl> + +<dl class="py class"> +<dt class="sig sig-object py" id="datafusion.html_formatter.FormatterManager"> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.html_formatter.</span></span><span class="sig-name descname"><span class="pre">FormatterManager</span></span><a class="headerlink" href="#datafusion.html_formatter.FormatterManager" title="Link to this definition">¶</a></dt> +<dd><p>Manager class for the global DataFrame HTML formatter instance.</p> +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.FormatterManager.get_formatter"> +<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_formatter</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.html_formatter.DataFrameHtmlFormatter" title="datafusion.html_formatter.DataFrameHtmlFormatter"><span class="pre">DataFrameHtmlFormatter</span></a></span></span><a class="headerlink" href="#datafusion.html_formatter.FormatterManager.get_formatter" title="Link to this definition">¶</a></dt> +<dd><p>Get the current global DataFrame HTML formatter.</p> +<dl class="field-list simple"> +<dt class="field-odd">Returns<span class="colon">:</span></dt> +<dd class="field-odd"><p>The global HTML formatter instance</p> +</dd> +</dl> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.FormatterManager.set_formatter"> +<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_formatter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">formatter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.html_formatter.DataFrameHtmlFormatter" title="datafusion.html_formatter.DataFrameHtmlFormatter"><span class="pre">DataFrameHtmlFormatter</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.html_formatter.FormatterManager.set_formatter" title="Link to this definition">¶</a></dt> +<dd><p>Set the global DataFrame HTML formatter.</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><p><strong>formatter</strong> – The formatter instance to use globally</p> +</dd> +</dl> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.html_formatter.FormatterManager._default_formatter"> +<span class="sig-name descname"><span class="pre">_default_formatter</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.html_formatter.DataFrameHtmlFormatter" title="datafusion.html_formatter.DataFrameHtmlFormatter"><span class="pre">DataFrameHtmlFormatter</span></a></em><a class="headerlink" href="#datafusion.html_formatter.FormatterManager._default_formatter" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +</dd></dl> + +<dl class="py class"> +<dt class="sig sig-object py" id="datafusion.html_formatter.StyleProvider"> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.html_formatter.</span></span><span class="sig-name descname"><span class="pre">StyleProvider</span></span><a class="headerlink" href="#datafusion.html_formatter.StyleProvider" title="Link to this definition">¶</a></dt> +<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">Protocol</span></code></p> +<p>Protocol for HTML style providers.</p> +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.StyleProvider.get_cell_style"> +<span class="sig-name descname"><span class="pre">get_cell_style</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.html_formatter.StyleProvider.get_cell_style" title="Link to this definition">¶</a></dt> +<dd><p>Get the CSS style for table cells.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.html_formatter.StyleProvider.get_header_style"> +<span class="sig-name descname"><span class="pre">get_header_style</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.html_formatter.StyleProvider.get_header_style" title="Link to this definition">¶</a></dt> +<dd><p>Get the CSS style for header cells.</p> +</dd></dl> + +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="datafusion.html_formatter._refresh_formatter_reference"> +<span class="sig-prename descclassname"><span class="pre">datafusion.html_formatter.</span></span><span class="sig-name descname"><span class="pre">_refresh_formatter_reference</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.html_formatter._refresh_formatter_reference" title="Link to this definition">¶</a></dt> +<dd><p>Refresh formatter reference in any modules using it.</p> +<p>This helps ensure that changes to the formatter are reflected in existing +DataFrames that might be caching the formatter reference.</p> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="datafusion.html_formatter._validate_bool"> +<span class="sig-prename descclassname"><span class="pre">datafusion.html_formatter.</span></span><span class="sig-name descname"><span class="pre">_validate_bool</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">param_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.html_formatter._validate_bool" title="Link to this definition">¶</a></dt> +<dd><p>Validate that a parameter is a boolean.</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>value</strong> – The value to validate</p></li> +<li><p><strong>param_name</strong> – Name of the parameter (used in error message)</p></li> +</ul> +</dd> +<dt class="field-even">Raises<span class="colon">:</span></dt> +<dd class="field-even"><p><strong>TypeError</strong> – If the value is not a boolean</p> +</dd> +</dl> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="datafusion.html_formatter._validate_positive_int"> +<span class="sig-prename descclassname"><span class="pre">datafusion.html_formatter.</span></span><span class="sig-name descname"><span class="pre">_validate_positive_int</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">param_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.html_formatter._validate_positive_int" title="Link to this definition">¶</a></dt> +<dd><p>Validate that a parameter is a positive integer.</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>value</strong> – The value to validate</p></li> +<li><p><strong>param_name</strong> – Name of the parameter (used in error message)</p></li> +</ul> +</dd> +<dt class="field-even">Raises<span class="colon">:</span></dt> +<dd class="field-even"><p><strong>ValueError</strong> – If the value is not a positive integer</p> +</dd> +</dl> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="datafusion.html_formatter.configure_formatter"> +<span class="sig-prename descclassname"><span class="pre">datafusion.html_formatter.</span></span><span class="sig-name descname"><span class="pre">configure_formatter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.html_formatter.configure_formatter" title="Link to this definition">¶</a></dt> +<dd><p>Configure the global DataFrame HTML formatter.</p> +<p>This function creates a new formatter with the provided configuration +and sets it as the global formatter for all DataFrames.</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><p><strong>**kwargs</strong> – Formatter configuration parameters like max_cell_length, +max_width, max_height, enable_cell_expansion, etc.</p> +</dd> +<dt class="field-even">Raises<span class="colon">:</span></dt> +<dd class="field-even"><p><strong>ValueError</strong> – If any invalid parameters are provided</p> +</dd> +</dl> +<p class="rubric">Example</p> +<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datafusion.html_formatter</span><span class="w"> </span><span class="kn">import</span> <span class="n">configure_formatter</span> +<span class="gp">>>> </span><span class="n">configure_formatter</span><span class="p">(</span> +<span class="gp">... </span> <span class="n">max_cell_length</span><span class="o">=</span><span class="mi">50</span><span class="p">,</span> +<span class="gp">... </span> <span class="n">max_height</span><span class="o">=</span><span class="mi">500</span><span class="p">,</span> +<span class="gp">... </span> <span class="n">enable_cell_expansion</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> +<span class="gp">... </span> <span class="n">use_shared_styles</span><span class="o">=</span><span class="kc">True</span> +<span class="gp">... </span><span class="p">)</span> +</pre></div> +</div> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="datafusion.html_formatter.get_formatter"> +<span class="sig-prename descclassname"><span class="pre">datafusion.html_formatter.</span></span><span class="sig-name descname"><span class="pre">get_formatter</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.html_formatter.DataFrameHtmlFormatter" title="datafusion.html_formatter.DataFrameHtmlFormatter"><span class="pre">DataFrameHtmlFormatter</span></a></span></span><a class="headerlink" href="#datafusion.html_formatter.get_formatter" title="Link to this definition">¶</a></dt> +<dd><p>Get the current global DataFrame HTML formatter.</p> +<p>This function is used by the DataFrame._repr_html_ implementation to access +the shared formatter instance. It can also be used directly when custom +HTML rendering is needed.</p> +<dl class="field-list simple"> +<dt class="field-odd">Returns<span class="colon">:</span></dt> +<dd class="field-odd"><p>The global HTML formatter instance</p> +</dd> +</dl> +<p class="rubric">Example</p> +<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datafusion.html_formatter</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_formatter</span> +<span class="gp">>>> </span><span class="n">formatter</span> <span class="o">=</span> <span class="n">get_formatter</span><span class="p">()</span> +<span class="gp">>>> </span><span class="n">formatter</span><span class="o">.</span><span class="n">max_cell_length</span> <span class="o">=</span> <span class="mi">50</span> <span class="c1"># Increase cell length</span> +</pre></div> +</div> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="datafusion.html_formatter.reset_formatter"> +<span class="sig-prename descclassname"><span class="pre">datafusion.html_formatter.</span></span><span class="sig-name descname"><span class="pre">reset_formatter</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.html_formatter.reset_formatter" title="Link to this definition">¶</a></dt> +<dd><p>Reset the global DataFrame HTML formatter to default settings.</p> +<p>This function creates a new formatter with default configuration +and sets it as the global formatter for all DataFrames.</p> +<p class="rubric">Example</p> +<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datafusion.html_formatter</span><span class="w"> </span><span class="kn">import</span> <span class="n">reset_formatter</span> +<span class="gp">>>> </span><span class="n">reset_formatter</span><span class="p">()</span> <span class="c1"># Reset formatter to default settings</span> +</pre></div> +</div> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="datafusion.html_formatter.reset_styles_loaded_state"> +<span class="sig-prename descclassname"><span class="pre">datafusion.html_formatter.</span></span><span class="sig-name descname"><span class="pre">reset_styles_loaded_state</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.html_formatter.reset_styles_loaded_state" title="Link to this definition">¶</a></dt> +<dd><p>Reset the styles loaded state to force reloading of styles.</p> +<p>This can be useful when switching between notebook sessions or +when styles need to be refreshed.</p> +<p class="rubric">Example</p> +<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datafusion.html_formatter</span><span class="w"> </span><span class="kn">import</span> <span class="n">reset_styles_loaded_state</span> +<span class="gp">>>> </span><span class="n">reset_styles_loaded_state</span><span class="p">()</span> <span class="c1"># Force styles to reload in next render</span> +</pre></div> +</div> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="datafusion.html_formatter.set_formatter"> +<span class="sig-prename descclassname"><span class="pre">datafusion.html_formatter.</span></span><span class="sig-name descname"><span class="pre">set_formatter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">formatter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.html_formatter.DataFrameHtmlFormatter" title="datafusion.html_formatter.DataFrameHtmlFormatter"><span class="pre">DataFrameHtmlFormatter</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.html_formatter.set_formatter" title="Link to this definition">¶</a></dt> +<dd><p>Set the global DataFrame HTML formatter.</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><p><strong>formatter</strong> – The formatter instance to use globally</p> +</dd> +</dl> +<p class="rubric">Example</p> +<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datafusion.html_formatter</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_formatter</span><span class="p">,</span> <span class="n">set_formatter</span> +<span class="gp">>>> </span><span class="n">custom_formatter</span> <span class="o">=</span> <span class="n">DataFrameHtmlFormatter</span><span class="p">(</span><span class="n">max_cell_length</span><span class="o">=</span><span class="mi">100</span><span class="p">)</span> +<span class="gp">>>> </span><span class="n">set_formatter</span><span class="p">(</span><span class="n">custom_formatter</span><span class="p">)</span> +</pre></div> +</div> +</dd></dl> + +</section> +</section> + + + </div> + + + <!-- Previous / next buttons --> +<div class='prev-next-area'> + <a class='left-prev' id="prev-link" href="../functions/index.html" title="previous page"> + <i class="fas fa-angle-left"></i> + <div class="prev-next-info"> + <p class="prev-next-subtitle">previous</p> + <p class="prev-next-title">datafusion.functions</p> + </div> + </a> + <a class='right-next' id="next-link" href="../input/index.html" title="next page"> + <div class="prev-next-info"> + <p class="prev-next-subtitle">next</p> + <p class="prev-next-title">datafusion.input</p> + </div> + <i class="fas fa-angle-right"></i> + </a> +</div> + + </main> + + + </div> + </div> + + <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> + +<!-- Based on pydata_sphinx_theme/footer.html --> +<footer class="footer mt-5 mt-md-0"> + <div class="container"> + + <div class="footer-item"> + <p class="copyright"> + © Copyright 2019-2024, Apache Software Foundation.<br> +</p> + </div> + + <div class="footer-item"> + <p class="sphinx-version"> +Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.1.3.<br> +</p> + </div> + + <div class="footer-item"> + <p>Apache Arrow DataFusion, Arrow DataFusion, Apache, the Apache feather logo, and the Apache Arrow DataFusion project logo</p> + <p>are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.</p> + </div> + </div> +</footer> + + + </body> +</html> \ No newline at end of file
diff --git a/autoapi/datafusion/index.html b/autoapi/datafusion/index.html index 7e5257e..af84cab 100644 --- a/autoapi/datafusion/index.html +++ b/autoapi/datafusion/index.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../user-guide/common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul> @@ -807,6 +832,33 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.abs"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.abs() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.acos"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.acos() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.acosh"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.acosh() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.Expr.alias"> <code class="docutils literal notranslate"> <span class="pre"> @@ -816,6 +868,123 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.array_dims"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.array_dims() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.array_distinct"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.array_distinct() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.array_empty"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.array_empty() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.array_length"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.array_length() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.array_ndims"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.array_ndims() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.array_pop_back"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.array_pop_back() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.array_pop_front"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.array_pop_front() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.arrow_typeof"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.arrow_typeof() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.ascii"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.ascii() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.asin"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.asin() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.asinh"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.asinh() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.atan"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.atan() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.atanh"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.atanh() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.Expr.between"> <code class="docutils literal notranslate"> <span class="pre"> @@ -825,6 +994,24 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.bit_length"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.bit_length() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.btrim"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.btrim() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.Expr.canonical_name"> <code class="docutils literal notranslate"> <span class="pre"> @@ -834,6 +1021,15 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.cardinality"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.cardinality() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.Expr.cast"> <code class="docutils literal notranslate"> <span class="pre"> @@ -843,6 +1039,51 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.cbrt"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.cbrt() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.ceil"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.ceil() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.char_length"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.char_length() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.character_length"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.character_length() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.chr"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.chr() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.Expr.column"> <code class="docutils literal notranslate"> <span class="pre"> @@ -861,6 +1102,42 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.cos"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.cos() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.cosh"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.cosh() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.cot"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.cot() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.degrees"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.degrees() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.Expr.display_name"> <code class="docutils literal notranslate"> <span class="pre"> @@ -879,6 +1156,33 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.empty"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.empty() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.exp"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.exp() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.factorial"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.factorial() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.Expr.fill_nan"> <code class="docutils literal notranslate"> <span class="pre"> @@ -906,6 +1210,42 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.flatten"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.flatten() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.floor"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.floor() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.from_unixtime"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.from_unixtime() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.initcap"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.initcap() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.Expr.is_not_null"> <code class="docutils literal notranslate"> <span class="pre"> @@ -924,6 +1264,69 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.isnan"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.isnan() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.iszero"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.iszero() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.length"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.length() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.list_dims"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.list_dims() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.list_distinct"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.list_distinct() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.list_length"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.list_length() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.list_ndims"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.list_ndims() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.Expr.literal"> <code class="docutils literal notranslate"> <span class="pre"> @@ -933,6 +1336,60 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.ln"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.ln() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.log10"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.log10() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.log2"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.log2() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.lower"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.lower() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.ltrim"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.ltrim() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.md5"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.md5() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.Expr.null_treatment"> <code class="docutils literal notranslate"> <span class="pre"> @@ -942,6 +1399,15 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.octet_length"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.octet_length() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.Expr.order_by"> <code class="docutils literal notranslate"> <span class="pre"> @@ -978,6 +1444,24 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.radians"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.radians() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.reverse"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.reverse() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.Expr.rex_call_operands"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1005,6 +1489,15 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.rtrim"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.rtrim() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.Expr.schema_name"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1014,6 +1507,69 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.sha224"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.sha224() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.sha256"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.sha256() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.sha384"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.sha384() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.sha512"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.sha512() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.signum"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.signum() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.sin"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.sin() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.sinh"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.sinh() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.Expr.sort"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1023,6 +1579,15 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.sqrt"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.sqrt() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.Expr.string_literal"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1032,6 +1597,33 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.tan"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.tan() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.tanh"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.tanh() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.to_hex"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.to_hex() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.Expr.to_variant"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1041,6 +1633,15 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.trim"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.trim() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.Expr.types"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1050,6 +1651,15 @@ </a> </li> <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.Expr.upper"> + <code class="docutils literal notranslate"> + <span class="pre"> + Expr.upper() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.Expr.variant_name"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1689,6 +2299,71 @@ </ul> </li> <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.TableFunction"> + <code class="docutils literal notranslate"> + <span class="pre"> + TableFunction + </span> + </code> + </a> + <ul class="nav section-nav flex-column"> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.TableFunction.__call__"> + <code class="docutils literal notranslate"> + <span class="pre"> + TableFunction.__call__() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.TableFunction.__repr__"> + <code class="docutils literal notranslate"> + <span class="pre"> + TableFunction.__repr__() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.TableFunction._create_table_udf"> + <code class="docutils literal notranslate"> + <span class="pre"> + TableFunction._create_table_udf() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.TableFunction._create_table_udf_decorator"> + <code class="docutils literal notranslate"> + <span class="pre"> + TableFunction._create_table_udf_decorator() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.TableFunction.udtf"> + <code class="docutils literal notranslate"> + <span class="pre"> + TableFunction.udtf() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.TableFunction._udtf"> + <code class="docutils literal notranslate"> + <span class="pre"> + TableFunction._udtf + </span> + </code> + </a> + </li> + </ul> + </li> + <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.WindowFrame"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1810,19 +2485,10 @@ </ul> </li> <li class="toc-h3 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.col"> + <a class="reference internal nav-link" href="#datafusion.configure_formatter"> <code class="docutils literal notranslate"> <span class="pre"> - col() - </span> - </code> - </a> - </li> - <li class="toc-h3 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.column"> - <code class="docutils literal notranslate"> - <span class="pre"> - column() + configure_formatter() </span> </code> </a> @@ -1891,6 +2557,24 @@ </a> </li> <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.col"> + <code class="docutils literal notranslate"> + <span class="pre"> + col + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.column"> + <code class="docutils literal notranslate"> + <span class="pre"> + column + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.udaf"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1909,6 +2593,15 @@ </a> </li> <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.udtf"> + <code class="docutils literal notranslate"> + <span class="pre"> + udtf + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#datafusion.udwf"> <code class="docutils literal notranslate"> <span class="pre"> @@ -1950,10 +2643,12 @@ <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="catalog/index.html">datafusion.catalog</a></li> +<li class="toctree-l1"><a class="reference internal" href="col/index.html">datafusion.col</a></li> <li class="toctree-l1"><a class="reference internal" href="context/index.html">datafusion.context</a></li> <li class="toctree-l1"><a class="reference internal" href="dataframe/index.html">datafusion.dataframe</a></li> <li class="toctree-l1"><a class="reference internal" href="expr/index.html">datafusion.expr</a></li> <li class="toctree-l1"><a class="reference internal" href="functions/index.html">datafusion.functions</a></li> +<li class="toctree-l1"><a class="reference internal" href="html_formatter/index.html">datafusion.html_formatter</a></li> <li class="toctree-l1"><a class="reference internal" href="input/index.html">datafusion.input</a></li> <li class="toctree-l1"><a class="reference internal" href="io/index.html">datafusion.io</a></li> <li class="toctree-l1"><a class="reference internal" href="object_store/index.html">datafusion.object_store</a></li> @@ -1961,6 +2656,8 @@ <li class="toctree-l1"><a class="reference internal" href="record_batch/index.html">datafusion.record_batch</a></li> <li class="toctree-l1"><a class="reference internal" href="substrait/index.html">datafusion.substrait</a></li> <li class="toctree-l1"><a class="reference internal" href="udf/index.html">datafusion.udf</a></li> +<li class="toctree-l1"><a class="reference internal" href="unparser/index.html">datafusion.unparser</a></li> +<li class="toctree-l1"><a class="reference internal" href="user_defined/index.html">datafusion.user_defined</a></li> </ul> </div> </section> @@ -1971,13 +2668,22 @@ <tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.DFSchema" title="datafusion.DFSchema"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DFSchema</span></code></a></p></td> <td><p></p></td> </tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.col" title="datafusion.col"><code class="xref py py-obj docutils literal notranslate"><span class="pre">col</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.column" title="datafusion.column"><code class="xref py py-obj docutils literal notranslate"><span class="pre">column</span></code></a></p></td> +<td><p></p></td> +</tr> <tr class="row-even"><td><p><a class="reference internal" href="#datafusion.udaf" title="datafusion.udaf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">udaf</span></code></a></p></td> <td><p></p></td> </tr> <tr class="row-odd"><td><p><a class="reference internal" href="udf/index.html#module-datafusion.udf" title="datafusion.udf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">udf</span></code></a></p></td> <td><p></p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.udwf" title="datafusion.udwf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">udwf</span></code></a></p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.udtf" title="datafusion.udtf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">udtf</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.udwf" title="datafusion.udwf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">udwf</span></code></a></p></td> <td><p></p></td> </tr> </tbody> @@ -2029,10 +2735,13 @@ <tr class="row-even"><td><p><a class="reference internal" href="#datafusion.Table" title="datafusion.Table"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Table</span></code></a></p></td> <td><p>DataFusion table.</p></td> </tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.WindowFrame" title="datafusion.WindowFrame"><code class="xref py py-obj docutils literal notranslate"><span class="pre">WindowFrame</span></code></a></p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.TableFunction" title="datafusion.TableFunction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TableFunction</span></code></a></p></td> +<td><p>Class for performing user-defined table functions (UDTF).</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.WindowFrame" title="datafusion.WindowFrame"><code class="xref py py-obj docutils literal notranslate"><span class="pre">WindowFrame</span></code></a></p></td> <td><p>Defines a window frame for performing window operations.</p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.WindowUDF" title="datafusion.WindowUDF"><code class="xref py py-obj docutils literal notranslate"><span class="pre">WindowUDF</span></code></a></p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.WindowUDF" title="datafusion.WindowUDF"><code class="xref py py-obj docutils literal notranslate"><span class="pre">WindowUDF</span></code></a></p></td> <td><p>Class for performing window user-defined functions (UDF).</p></td> </tr> </tbody> @@ -2042,28 +2751,25 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading">¶</a></h2> <table class="autosummary longtable table autosummary"> <tbody> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.col" title="datafusion.col"><code class="xref py py-obj docutils literal notranslate"><span class="pre">col</span></code></a>(→ expr.Expr)</p></td> -<td><p>Create a column expression.</p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.configure_formatter" title="datafusion.configure_formatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">configure_formatter</span></code></a>(→ None)</p></td> +<td><p>Configure the global DataFrame HTML formatter.</p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.column" title="datafusion.column"><code class="xref py py-obj docutils literal notranslate"><span class="pre">column</span></code></a>(→ expr.Expr)</p></td> -<td><p>Create a column expression.</p></td> -</tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.lit" title="datafusion.lit"><code class="xref py py-obj docutils literal notranslate"><span class="pre">lit</span></code></a>(→ expr.Expr)</p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.lit" title="datafusion.lit"><code class="xref py py-obj docutils literal notranslate"><span class="pre">lit</span></code></a>(→ expr.Expr)</p></td> <td><p>Create a literal expression.</p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.literal" title="datafusion.literal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">literal</span></code></a>(→ expr.Expr)</p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.literal" title="datafusion.literal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">literal</span></code></a>(→ expr.Expr)</p></td> <td><p>Create a literal expression.</p></td> </tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.read_avro" title="datafusion.read_avro"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_avro</span></code></a>(→ datafusion.dataframe.DataFrame)</p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.read_avro" title="datafusion.read_avro"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_avro</span></code></a>(→ datafusion.dataframe.DataFrame)</p></td> <td><p>Create a <code class="xref py py-class docutils literal notranslate"><span class="pre">DataFrame</span></code> for reading Avro data source.</p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.read_csv" title="datafusion.read_csv"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_csv</span></code></a>(→ datafusion.dataframe.DataFrame)</p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.read_csv" title="datafusion.read_csv"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_csv</span></code></a>(→ datafusion.dataframe.DataFrame)</p></td> <td><p>Read a CSV data source.</p></td> </tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.read_json" title="datafusion.read_json"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_json</span></code></a>(→ datafusion.dataframe.DataFrame)</p></td> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.read_json" title="datafusion.read_json"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_json</span></code></a>(→ datafusion.dataframe.DataFrame)</p></td> <td><p>Read a line-delimited JSON data source.</p></td> </tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.read_parquet" title="datafusion.read_parquet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_parquet</span></code></a>(→ datafusion.dataframe.DataFrame)</p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.read_parquet" title="datafusion.read_parquet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_parquet</span></code></a>(→ datafusion.dataframe.DataFrame)</p></td> <td><p>Read a Parquet source into a <code class="xref py py-class docutils literal notranslate"><span class="pre">Dataframe</span></code>.</p></td> </tr> </tbody> @@ -2103,7 +2809,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datafusion.AggregateUDF"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.</span></span><span class="sig-name descname"><span class="pre">AggregateUDF</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">accumulator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.Accumulator" title="datafusion.Accumulator"><span class="pre">Accumulator</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="udf/index.html#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.AggregateUDF" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.</span></span><span class="sig-name descname"><span class="pre">AggregateUDF</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">accumulator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.Accumulator" title="datafusion.Accumulator"><span class="pre">Accumulator</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="user_defined/index.html#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.AggregateUDF" title="Link to this definition">¶</a></dt> <dd><p>Class for performing scalar user-defined functions (UDF).</p> <p>Aggregate UDFs operate on a group of rows and return a single value. See also <a class="reference internal" href="#datafusion.ScalarUDF" title="datafusion.ScalarUDF"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScalarUDF</span></code></a> for operating on a row by row basis.</p> @@ -2120,78 +2826,67 @@ <dl class="py method"> <dt class="sig sig-object py" id="datafusion.AggregateUDF.udaf"> -<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udaf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="udf/index.html#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.AggregateUDF" title="datafusion.AggregateUDF"><span class="pre">AggregateUDF</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.AggregateUDF.udaf" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udaf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="user_defined/index.html#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.AggregateUDF" title="datafusion.AggregateUDF"><span class="pre">AggregateUDF</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.AggregateUDF.udaf" title="Link to this definition">¶</a></dt> <dt class="sig sig-object py"> -<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udaf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">accum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.Accumulator" title="datafusion.Accumulator"><span class="pre">Accumulator</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="udf/index.html#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.AggregateUDF" title="datafusion.AggregateUDF"><span class="pre">AggregateUDF</span></a></span></span></dt> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udaf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">accum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.Accumulator" title="datafusion.Accumulator"><span class="pre">Accumulator</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="user_defined/index.html#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.AggregateUDF" title="datafusion.AggregateUDF"><span class="pre">AggregateUDF</span></a></span></span></dt> <dd><p>Create a new User-Defined Aggregate Function (UDAF).</p> -<p>This class allows you to define an <strong>aggregate function</strong> that can be used in +<p>This class allows you to define an aggregate function that can be used in data aggregation or window function calls.</p> -<dl> +<dl class="simple"> <dt>Usage:</dt><dd><ul class="simple"> -<li><dl class="simple"> -<dt><strong>As a function</strong>: Call <a href="#id1"><span class="problematic" id="id2">`</span></a>udaf(accum, input_types, return_type, state_type,</dt><dd><p>volatility, name)`.</p> -</dd> -</dl> -</li> -<li><dl class="simple"> -<dt><strong>As a decorator</strong>: Use <a href="#id3"><span class="problematic" id="id4">`</span></a>@udaf(input_types, return_type, state_type,</dt><dd><p>volatility, name)`.</p> -</dd> -</dl> -</li> +<li><p>As a function: <code class="docutils literal notranslate"><span class="pre">udaf(accum,</span> <span class="pre">input_types,</span> <span class="pre">return_type,</span> <span class="pre">state_type,</span> <span class="pre">volatility,</span> <span class="pre">name)</span></code>.</p></li> +<li><p>As a decorator: <code class="docutils literal notranslate"><span class="pre">@udaf(input_types,</span> <span class="pre">return_type,</span> <span class="pre">state_type,</span> <span class="pre">volatility,</span> <span class="pre">name)</span></code>. +When using <code class="docutils literal notranslate"><span class="pre">udaf</span></code> as a decorator, do not pass <code class="docutils literal notranslate"><span class="pre">accum</span></code> explicitly.</p></li> </ul> -<p>When using <cite>udaf</cite> as a decorator, <strong>do not pass `accum` explicitly</strong>.</p> </dd> </dl> -<p><strong>Function example:</strong></p> -<blockquote> -<div><p>If your <cite>:py:class:Accumulator</cite> can be instantiated with no arguments, you +<p>Function example:</p> +<p>If your <a class="reference internal" href="#datafusion.Accumulator" title="datafusion.Accumulator"><code class="xref py py-class docutils literal notranslate"><span class="pre">Accumulator</span></code></a> can be instantiated with no arguments, you can simply pass it’s type as <cite>accum</cite>. If you need to pass additional arguments to it’s constructor, you can define a lambda or a factory method. -During runtime the <cite>:py:class:Accumulator</cite> will be constructed for every -instance in which this UDAF is used. The following examples are all valid. -<a href="#id5"><span class="problematic" id="id6">``</span></a>` -import pyarrow as pa -import pyarrow.compute as pc</p> -<dl class="simple"> -<dt>class Summarize(Accumulator):</dt><dd><dl class="simple"> -<dt>def __init__(self, bias: float = 0.0):</dt><dd><p>self._sum = pa.scalar(bias)</p> -</dd> -<dt>def state(self) -> list[pa.Scalar]:</dt><dd><p>return [self._sum]</p> -</dd> -<dt>def update(self, values: pa.Array) -> None:</dt><dd><p>self._sum = pa.scalar(self._sum.as_py() + pc.sum(values).as_py())</p> -</dd> -<dt>def merge(self, states: list[pa.Array]) -> None:</dt><dd><p>self._sum = pa.scalar(self._sum.as_py() + pc.sum(states[0]).as_py())</p> -</dd> -<dt>def evaluate(self) -> pa.Scalar:</dt><dd><p>return self._sum</p> -</dd> -</dl> -</dd> -<dt>def sum_bias_10() -> Summarize:</dt><dd><p>return Summarize(10.0)</p> -</dd> -<dt>udaf1 = udaf(Summarize, pa.float64(), pa.float64(), [pa.float64()],</dt><dd><p>“immutable”)</p> -</dd> -<dt>udaf2 = udaf(sum_bias_10, pa.float64(), pa.float64(), [pa.float64()],</dt><dd><p>“immutable”)</p> -</dd> -<dt>udaf3 = udaf(lambda: Summarize(20.0), pa.float64(), pa.float64(),</dt><dd><p>[pa.float64()], “immutable”)</p> -</dd> -</dl> -<p><a href="#id7"><span class="problematic" id="id8">``</span></a><a href="#id9"><span class="problematic" id="id10">`</span></a></p> -</div></blockquote> -<dl> -<dt><strong>Decorator example:</strong></dt><dd><p><a href="#id11"><span class="problematic" id="id12">``</span></a>` -@udaf(pa.float64(), pa.float64(), [pa.float64()], “immutable”) -def udf4() -> Summarize:</p> -<blockquote> -<div><p>return Summarize(10.0)</p> -</div></blockquote> -<p><a href="#id13"><span class="problematic" id="id14">``</span></a><a href="#id15"><span class="problematic" id="id16">`</span></a></p> -</dd> -</dl> +During runtime the <a class="reference internal" href="#datafusion.Accumulator" title="datafusion.Accumulator"><code class="xref py py-class docutils literal notranslate"><span class="pre">Accumulator</span></code></a> will be constructed for every +instance in which this UDAF is used. The following examples are all valid:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">pyarrow</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">pa</span> +<span class="kn">import</span><span class="w"> </span><span class="nn">pyarrow.compute</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">pc</span> + +<span class="k">class</span><span class="w"> </span><span class="nc">Summarize</span><span class="p">(</span><span class="n">Accumulator</span><span class="p">):</span> + <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bias</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.0</span><span class="p">):</span> + <span class="bp">self</span><span class="o">.</span><span class="n">_sum</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">scalar</span><span class="p">(</span><span class="n">bias</span><span class="p">)</span> + + <span class="k">def</span><span class="w"> </span><span class="nf">state</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">list</span><span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">Scalar</span><span class="p">]:</span> + <span class="k">return</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_sum</span><span class="p">]</span> + + <span class="k">def</span><span class="w"> </span><span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">values</span><span class="p">:</span> <span class="n">pa</span><span class="o">.</span><span class="n">Array</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> + <span class="bp">self</span><span class="o">.</span><span class="n">_sum</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">scalar</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_sum</span><span class="o">.</span><span class="n">as_py</span><span class="p">()</span> <span class="o">+</span> <span class="n">pc</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">values</span><span class="p">)</span><span class="o">.</span><span class="n">as_py</span><span class="p">())</span> + + <span class="k">def</span><span class="w"> </span><span class="nf">merge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">states</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">Array</span><span class="p">])</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> + <span class="bp">self</span><span class="o">.</span><span class="n">_sum</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">scalar</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_sum</span><span class="o">.</span><span class="n">as_py</span><span class="p">()</span> <span class="o">+</span> <span class="n">pc</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">states</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span><span class="o">.</span><span class="n">as_py</span><span class="p">())</span> + + <span class="k">def</span><span class="w"> </span><span class="nf">evaluate</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">pa</span><span class="o">.</span><span class="n">Scalar</span><span class="p">:</span> + <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sum</span> + +<span class="k">def</span><span class="w"> </span><span class="nf">sum_bias_10</span><span class="p">()</span> <span class="o">-></span> <span class="n">Summarize</span><span class="p">:</span> + <span class="k">return</span> <span class="n">Summarize</span><span class="p">(</span><span class="mf">10.0</span><span class="p">)</span> + +<span class="n">udaf1</span> <span class="o">=</span> <span class="n">udaf</span><span class="p">(</span><span class="n">Summarize</span><span class="p">,</span> <span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">(),</span> <span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">(),</span> <span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">()],</span> + <span class="s2">"immutable"</span><span class="p">)</span> +<span class="n">udaf2</span> <span class="o">=</span> <span class="n">udaf</span><span class="p">(</span><span class="n">sum_bias_10</span><span class="p">,</span> <span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">(),</span> <span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">(),</span> <span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">()],</span> + <span class="s2">"immutable"</span><span class="p">)</span> +<span class="n">udaf3</span> <span class="o">=</span> <span class="n">udaf</span><span class="p">(</span><span class="k">lambda</span><span class="p">:</span> <span class="n">Summarize</span><span class="p">(</span><span class="mf">20.0</span><span class="p">),</span> <span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">(),</span> <span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">(),</span> + <span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">()],</span> <span class="s2">"immutable"</span><span class="p">)</span> +</pre></div> +</div> +<p>Decorator example::</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@udaf</span><span class="p">(</span><span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">(),</span> <span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">(),</span> <span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">()],</span> <span class="s2">"immutable"</span><span class="p">)</span> +<span class="k">def</span><span class="w"> </span><span class="nf">udf4</span><span class="p">()</span> <span class="o">-></span> <span class="n">Summarize</span><span class="p">:</span> + <span class="k">return</span> <span class="n">Summarize</span><span class="p">(</span><span class="mf">10.0</span><span class="p">)</span> +</pre></div> +</div> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>accum</strong> – The accumulator python function. <strong>Only needed when calling as a -function. Skip this argument when using `udaf` as a decorator.</strong></p></li> +<li><p><strong>accum</strong> – The accumulator python function. Only needed when calling as a +function. Skip this argument when using <code class="docutils literal notranslate"><span class="pre">udaf</span></code> as a decorator.</p></li> <li><p><strong>input_types</strong> – The data types of the arguments to <code class="docutils literal notranslate"><span class="pre">accum</span></code>.</p></li> <li><p><strong>return_type</strong> – The data type of the return value.</p></li> <li><p><strong>state_type</strong> – The data types of the intermediate accumulation.</p></li> @@ -2443,9 +3138,130 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.abs"> +<span class="sig-name descname"><span class="pre">abs</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.abs" title="Link to this definition">¶</a></dt> +<dd><p>Return the absolute value of a given number.</p> +<section id="returns"> +<h3>Returns:<a class="headerlink" href="#returns" title="Link to this heading">¶</a></h3> +<dl class="simple"> +<dt>Expr</dt><dd><p>A new expression representing the absolute value of the input expression.</p> +</dd> +</dl> +</section> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.acos"> +<span class="sig-name descname"><span class="pre">acos</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.acos" title="Link to this definition">¶</a></dt> +<dd><p>Returns the arc cosine or inverse cosine of a number.</p> +<section id="id1"> +<h3>Returns:<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h3> +<dl class="simple"> +<dt>Expr</dt><dd><p>A new expression representing the arc cosine of the input expression.</p> +</dd> +</dl> +</section> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.acosh"> +<span class="sig-name descname"><span class="pre">acosh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.acosh" title="Link to this definition">¶</a></dt> +<dd><p>Returns inverse hyperbolic cosine.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.Expr.alias"> -<span class="sig-name descname"><span class="pre">alias</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.alias" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">alias</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.alias" title="Link to this definition">¶</a></dt> <dd><p>Assign a name to the expression.</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>name</strong> – The name to assign to the expression.</p></li> +<li><p><strong>metadata</strong> – Optional metadata to attach to the expression.</p></li> +</ul> +</dd> +<dt class="field-even">Returns<span class="colon">:</span></dt> +<dd class="field-even"><p>A new expression with the assigned name.</p> +</dd> +</dl> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.array_dims"> +<span class="sig-name descname"><span class="pre">array_dims</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.array_dims" title="Link to this definition">¶</a></dt> +<dd><p>Returns an array of the array’s dimensions.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.array_distinct"> +<span class="sig-name descname"><span class="pre">array_distinct</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.array_distinct" title="Link to this definition">¶</a></dt> +<dd><p>Returns distinct values from the array after removing duplicates.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.array_empty"> +<span class="sig-name descname"><span class="pre">array_empty</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.array_empty" title="Link to this definition">¶</a></dt> +<dd><p>Returns a boolean indicating whether the array is empty.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.array_length"> +<span class="sig-name descname"><span class="pre">array_length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.array_length" title="Link to this definition">¶</a></dt> +<dd><p>Returns the length of the array.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.array_ndims"> +<span class="sig-name descname"><span class="pre">array_ndims</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.array_ndims" title="Link to this definition">¶</a></dt> +<dd><p>Returns the number of dimensions of the array.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.array_pop_back"> +<span class="sig-name descname"><span class="pre">array_pop_back</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.array_pop_back" title="Link to this definition">¶</a></dt> +<dd><p>Returns the array without the last element.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.array_pop_front"> +<span class="sig-name descname"><span class="pre">array_pop_front</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.array_pop_front" title="Link to this definition">¶</a></dt> +<dd><p>Returns the array without the first element.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.arrow_typeof"> +<span class="sig-name descname"><span class="pre">arrow_typeof</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.arrow_typeof" title="Link to this definition">¶</a></dt> +<dd><p>Returns the Arrow type of the expression.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.ascii"> +<span class="sig-name descname"><span class="pre">ascii</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.ascii" title="Link to this definition">¶</a></dt> +<dd><p>Returns the numeric code of the first character of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.asin"> +<span class="sig-name descname"><span class="pre">asin</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.asin" title="Link to this definition">¶</a></dt> +<dd><p>Returns the arc sine or inverse sine of a number.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.asinh"> +<span class="sig-name descname"><span class="pre">asinh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.asinh" title="Link to this definition">¶</a></dt> +<dd><p>Returns inverse hyperbolic sine.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.atan"> +<span class="sig-name descname"><span class="pre">atan</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.atan" title="Link to this definition">¶</a></dt> +<dd><p>Returns inverse tangent of a number.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.atanh"> +<span class="sig-name descname"><span class="pre">atanh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.atanh" title="Link to this definition">¶</a></dt> +<dd><p>Returns inverse hyperbolic tangent.</p> </dd></dl> <dl class="py method"> @@ -2464,18 +3280,66 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.bit_length"> +<span class="sig-name descname"><span class="pre">bit_length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.bit_length" title="Link to this definition">¶</a></dt> +<dd><p>Returns the number of bits in the string argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.btrim"> +<span class="sig-name descname"><span class="pre">btrim</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.btrim" title="Link to this definition">¶</a></dt> +<dd><p>Removes all characters, spaces by default, from both sides of a string.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.Expr.canonical_name"> <span class="sig-name descname"><span class="pre">canonical_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.Expr.canonical_name" title="Link to this definition">¶</a></dt> <dd><p>Returns a complete string representation of this expression.</p> </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.cardinality"> +<span class="sig-name descname"><span class="pre">cardinality</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.cardinality" title="Link to this definition">¶</a></dt> +<dd><p>Returns the total number of elements in the array.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.Expr.cast"> <span class="sig-name descname"><span class="pre">cast</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">to</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">type</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.cast" title="Link to this definition">¶</a></dt> <dd><p>Cast to a new data type.</p> </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.cbrt"> +<span class="sig-name descname"><span class="pre">cbrt</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.cbrt" title="Link to this definition">¶</a></dt> +<dd><p>Returns the cube root of a number.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.ceil"> +<span class="sig-name descname"><span class="pre">ceil</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.ceil" title="Link to this definition">¶</a></dt> +<dd><p>Returns the nearest integer greater than or equal to argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.char_length"> +<span class="sig-name descname"><span class="pre">char_length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.char_length" title="Link to this definition">¶</a></dt> +<dd><p>The number of characters in the <code class="docutils literal notranslate"><span class="pre">string</span></code>.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.character_length"> +<span class="sig-name descname"><span class="pre">character_length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.character_length" title="Link to this definition">¶</a></dt> +<dd><p>Returns the number of characters in the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.chr"> +<span class="sig-name descname"><span class="pre">chr</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.chr" title="Link to this definition">¶</a></dt> +<dd><p>Converts the Unicode code point to a UTF8 character.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.Expr.column"> <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">column</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.column" title="Link to this definition">¶</a></dt> <dd><p>Creates a new expression representing a column.</p> @@ -2488,6 +3352,30 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.cos"> +<span class="sig-name descname"><span class="pre">cos</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.cos" title="Link to this definition">¶</a></dt> +<dd><p>Returns the cosine of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.cosh"> +<span class="sig-name descname"><span class="pre">cosh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.cosh" title="Link to this definition">¶</a></dt> +<dd><p>Returns the hyperbolic cosine of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.cot"> +<span class="sig-name descname"><span class="pre">cot</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.cot" title="Link to this definition">¶</a></dt> +<dd><p>Returns the cotangent of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.degrees"> +<span class="sig-name descname"><span class="pre">degrees</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.degrees" title="Link to this definition">¶</a></dt> +<dd><p>Converts the argument from radians to degrees.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.Expr.display_name"> <span class="sig-name descname"><span class="pre">display_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.Expr.display_name" title="Link to this definition">¶</a></dt> <dd><p>Returns the name of this expression as it should appear in a schema.</p> @@ -2504,6 +3392,24 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.empty"> +<span class="sig-name descname"><span class="pre">empty</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.empty" title="Link to this definition">¶</a></dt> +<dd><p>This is an alias for <a class="reference internal" href="#datafusion.Expr.array_empty" title="datafusion.Expr.array_empty"><code class="xref py py-func docutils literal notranslate"><span class="pre">array_empty()</span></code></a>.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.exp"> +<span class="sig-name descname"><span class="pre">exp</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.exp" title="Link to this definition">¶</a></dt> +<dd><p>Returns the exponential of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.factorial"> +<span class="sig-name descname"><span class="pre">factorial</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.factorial" title="Link to this definition">¶</a></dt> +<dd><p>Returns the factorial of the argument.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.Expr.fill_nan"> <span class="sig-name descname"><span class="pre">fill_nan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.fill_nan" title="Link to this definition">¶</a></dt> <dd><p>Fill NaN values with a provided value.</p> @@ -2525,6 +3431,32 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.flatten"> +<span class="sig-name descname"><span class="pre">flatten</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.flatten" title="Link to this definition">¶</a></dt> +<dd><p>Flattens an array of arrays into a single array.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.floor"> +<span class="sig-name descname"><span class="pre">floor</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.floor" title="Link to this definition">¶</a></dt> +<dd><p>Returns the nearest integer less than or equal to the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.from_unixtime"> +<span class="sig-name descname"><span class="pre">from_unixtime</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.from_unixtime" title="Link to this definition">¶</a></dt> +<dd><p>Converts an integer to RFC3339 timestamp format string.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.initcap"> +<span class="sig-name descname"><span class="pre">initcap</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.initcap" title="Link to this definition">¶</a></dt> +<dd><p>Set the initial letter of each word to capital.</p> +<p>Converts the first letter of each word in <code class="docutils literal notranslate"><span class="pre">string</span></code> to uppercase and the +remaining characters to lowercase.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.Expr.is_not_null"> <span class="sig-name descname"><span class="pre">is_not_null</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.is_not_null" title="Link to this definition">¶</a></dt> <dd><p>Returns <code class="docutils literal notranslate"><span class="pre">True</span></code> if this expression is not null.</p> @@ -2537,6 +3469,52 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.isnan"> +<span class="sig-name descname"><span class="pre">isnan</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.isnan" title="Link to this definition">¶</a></dt> +<dd><p>Returns true if a given number is +NaN or -NaN otherwise returns false.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.iszero"> +<span class="sig-name descname"><span class="pre">iszero</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.iszero" title="Link to this definition">¶</a></dt> +<dd><p>Returns true if a given number is +0.0 or -0.0 otherwise returns false.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.length"> +<span class="sig-name descname"><span class="pre">length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.length" title="Link to this definition">¶</a></dt> +<dd><p>The number of characters in the <code class="docutils literal notranslate"><span class="pre">string</span></code>.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.list_dims"> +<span class="sig-name descname"><span class="pre">list_dims</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.list_dims" title="Link to this definition">¶</a></dt> +<dd><p>Returns an array of the array’s dimensions.</p> +<p>This is an alias for <a class="reference internal" href="#datafusion.Expr.array_dims" title="datafusion.Expr.array_dims"><code class="xref py py-func docutils literal notranslate"><span class="pre">array_dims()</span></code></a>.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.list_distinct"> +<span class="sig-name descname"><span class="pre">list_distinct</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.list_distinct" title="Link to this definition">¶</a></dt> +<dd><p>Returns distinct values from the array after removing duplicates.</p> +<p>This is an alias for <a class="reference internal" href="#datafusion.Expr.array_distinct" title="datafusion.Expr.array_distinct"><code class="xref py py-func docutils literal notranslate"><span class="pre">array_distinct()</span></code></a>.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.list_length"> +<span class="sig-name descname"><span class="pre">list_length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.list_length" title="Link to this definition">¶</a></dt> +<dd><p>Returns the length of the array.</p> +<p>This is an alias for <a class="reference internal" href="#datafusion.Expr.array_length" title="datafusion.Expr.array_length"><code class="xref py py-func docutils literal notranslate"><span class="pre">array_length()</span></code></a>.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.list_ndims"> +<span class="sig-name descname"><span class="pre">list_ndims</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.list_ndims" title="Link to this definition">¶</a></dt> +<dd><p>Returns the number of dimensions of the array.</p> +<p>This is an alias for <a class="reference internal" href="#datafusion.Expr.array_ndims" title="datafusion.Expr.array_ndims"><code class="xref py py-func docutils literal notranslate"><span class="pre">array_ndims()</span></code></a>.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.Expr.literal"> <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">literal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.literal" title="Link to this definition">¶</a></dt> <dd><p>Creates a new expression representing a scalar value.</p> @@ -2544,6 +3522,42 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.ln"> +<span class="sig-name descname"><span class="pre">ln</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.ln" title="Link to this definition">¶</a></dt> +<dd><p>Returns the natural logarithm (base e) of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.log10"> +<span class="sig-name descname"><span class="pre">log10</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.log10" title="Link to this definition">¶</a></dt> +<dd><p>Base 10 logarithm of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.log2"> +<span class="sig-name descname"><span class="pre">log2</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.log2" title="Link to this definition">¶</a></dt> +<dd><p>Base 2 logarithm of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.lower"> +<span class="sig-name descname"><span class="pre">lower</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.lower" title="Link to this definition">¶</a></dt> +<dd><p>Converts a string to lowercase.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.ltrim"> +<span class="sig-name descname"><span class="pre">ltrim</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.ltrim" title="Link to this definition">¶</a></dt> +<dd><p>Removes all characters, spaces by default, from the beginning of a string.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.md5"> +<span class="sig-name descname"><span class="pre">md5</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.md5" title="Link to this definition">¶</a></dt> +<dd><p>Computes an MD5 128-bit checksum for a string expression.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.Expr.null_treatment"> <span class="sig-name descname"><span class="pre">null_treatment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">null_treatment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datafusion.common.NullTreatment</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">ExprFuncBuilder</span></span></span><a class="headerlink" href="#datafusion.Expr.null_treatment" title="Link to this definition">¶</a></dt> <dd><p>Set the treatment for <code class="docutils literal notranslate"><span class="pre">null</span></code> values for a window or aggregate function.</p> @@ -2553,6 +3567,12 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.octet_length"> +<span class="sig-name descname"><span class="pre">octet_length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.octet_length" title="Link to this definition">¶</a></dt> +<dd><p>Returns the number of bytes of a string.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.Expr.order_by"> <span class="sig-name descname"><span class="pre">order_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">exprs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="expr/index.html#datafusion.expr.SortExpr" title="datafusion.expr.SortExpr"><span class="pre">SortExpr</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">ExprFuncBuilder</span></span></span><a class="headerlink" href="#datafusion.Expr.order_by" title="Link to this definition">¶</a></dt> <dd><p>Set the ordering for a window or aggregate function.</p> @@ -2597,6 +3617,18 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.radians"> +<span class="sig-name descname"><span class="pre">radians</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.radians" title="Link to this definition">¶</a></dt> +<dd><p>Converts the argument from degrees to radians.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.reverse"> +<span class="sig-name descname"><span class="pre">reverse</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.reverse" title="Link to this definition">¶</a></dt> +<dd><p>Reverse the string argument.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.Expr.rex_call_operands"> <span class="sig-name descname"><span class="pre">rex_call_operands</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.Expr.rex_call_operands" title="Link to this definition">¶</a></dt> <dd><p>Return the operands of the expression based on it’s variant type.</p> @@ -2622,6 +3654,12 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.rtrim"> +<span class="sig-name descname"><span class="pre">rtrim</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.rtrim" title="Link to this definition">¶</a></dt> +<dd><p>Removes all characters, spaces by default, from the end of a string.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.Expr.schema_name"> <span class="sig-name descname"><span class="pre">schema_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.Expr.schema_name" title="Link to this definition">¶</a></dt> <dd><p>Returns the name of this expression as it should appear in a schema.</p> @@ -2629,6 +3667,48 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.sha224"> +<span class="sig-name descname"><span class="pre">sha224</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.sha224" title="Link to this definition">¶</a></dt> +<dd><p>Computes the SHA-224 hash of a binary string.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.sha256"> +<span class="sig-name descname"><span class="pre">sha256</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.sha256" title="Link to this definition">¶</a></dt> +<dd><p>Computes the SHA-256 hash of a binary string.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.sha384"> +<span class="sig-name descname"><span class="pre">sha384</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.sha384" title="Link to this definition">¶</a></dt> +<dd><p>Computes the SHA-384 hash of a binary string.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.sha512"> +<span class="sig-name descname"><span class="pre">sha512</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.sha512" title="Link to this definition">¶</a></dt> +<dd><p>Computes the SHA-512 hash of a binary string.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.signum"> +<span class="sig-name descname"><span class="pre">signum</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.signum" title="Link to this definition">¶</a></dt> +<dd><p>Returns the sign of the argument (-1, 0, +1).</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.sin"> +<span class="sig-name descname"><span class="pre">sin</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.sin" title="Link to this definition">¶</a></dt> +<dd><p>Returns the sine of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.sinh"> +<span class="sig-name descname"><span class="pre">sinh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.sinh" title="Link to this definition">¶</a></dt> +<dd><p>Returns the hyperbolic sine of the argument.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.Expr.sort"> <span class="sig-name descname"><span class="pre">sort</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ascending</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nulls_first</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="expr/index.html#datafusion.expr.SortExpr" title="datafusion.expr.SortExpr"><span class="pre">SortExpr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.sort" title="Link to this definition">¶</a></dt> <dd><p>Creates a sort <a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Expr</span></code></a> from an existing <a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Expr</span></code></a>.</p> @@ -2643,6 +3723,12 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.sqrt"> +<span class="sig-name descname"><span class="pre">sqrt</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.sqrt" title="Link to this definition">¶</a></dt> +<dd><p>Returns the square root of the argument.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.Expr.string_literal"> <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">string_literal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.string_literal" title="Link to this definition">¶</a></dt> <dd><p>Creates a new expression representing a UTF8 literal value.</p> @@ -2654,12 +3740,36 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.tan"> +<span class="sig-name descname"><span class="pre">tan</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.tan" title="Link to this definition">¶</a></dt> +<dd><p>Returns the tangent of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.tanh"> +<span class="sig-name descname"><span class="pre">tanh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.tanh" title="Link to this definition">¶</a></dt> +<dd><p>Returns the hyperbolic tangent of the argument.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.to_hex"> +<span class="sig-name descname"><span class="pre">to_hex</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.to_hex" title="Link to this definition">¶</a></dt> +<dd><p>Converts an integer to a hexadecimal string.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.Expr.to_variant"> <span class="sig-name descname"><span class="pre">to_variant</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Any</span></span></span><a class="headerlink" href="#datafusion.Expr.to_variant" title="Link to this definition">¶</a></dt> <dd><p>Convert this expression into a python object if possible.</p> </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.trim"> +<span class="sig-name descname"><span class="pre">trim</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.trim" title="Link to this definition">¶</a></dt> +<dd><p>Removes all characters, spaces by default, from both sides of a string.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.Expr.types"> <span class="sig-name descname"><span class="pre">types</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">datafusion.common.DataTypeMap</span></span></span><a class="headerlink" href="#datafusion.Expr.types" title="Link to this definition">¶</a></dt> <dd><p>Return the <code class="docutils literal notranslate"><span class="pre">DataTypeMap</span></code>.</p> @@ -2672,6 +3782,12 @@ </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="datafusion.Expr.upper"> +<span class="sig-name descname"><span class="pre">upper</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.Expr" title="datafusion.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.Expr.upper" title="Link to this definition">¶</a></dt> +<dd><p>Converts a string to uppercase.</p> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="datafusion.Expr.variant_name"> <span class="sig-name descname"><span class="pre">variant_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.Expr.variant_name" title="Link to this definition">¶</a></dt> <dd><p>Returns the name of the Expr variant.</p> @@ -3082,7 +4198,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datafusion.ScalarUDF"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.</span></span><span class="sig-name descname"><span class="pre">ScalarUDF</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">_R</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">_R</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="udf/index.html#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.ScalarUDF" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.</span></span><span class="sig-name descname"><span class="pre">ScalarUDF</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">_R</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">_R</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="user_defined/index.html#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.ScalarUDF" title="Link to this definition">¶</a></dt> <dd><p>Class for performing scalar user-defined functions (UDF).</p> <p>Scalar UDFs operate on a row by row basis. See also <a class="reference internal" href="#datafusion.AggregateUDF" title="datafusion.AggregateUDF"><code class="xref py py-class docutils literal notranslate"><span class="pre">AggregateUDF</span></code></a> for operating on a group of rows.</p> @@ -3098,30 +4214,29 @@ <dl class="py method"> <dt class="sig sig-object py" id="datafusion.ScalarUDF.udf"> -<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">_R</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="udf/index.html#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.ScalarUDF" title="datafusion.ScalarUDF"><span class="pre">ScalarUDF</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.ScalarUDF.udf" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">_R</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="user_defined/index.html#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.ScalarUDF" title="datafusion.ScalarUDF"><span class="pre">ScalarUDF</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.ScalarUDF.udf" title="Link to this definition">¶</a></dt> <dt class="sig sig-object py"> -<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">_R</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">_R</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="udf/index.html#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.ScalarUDF" title="datafusion.ScalarUDF"><span class="pre">ScalarUDF</span></a></span></span></dt> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">_R</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">_R</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="user_defined/index.html#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.ScalarUDF" title="datafusion.ScalarUDF"><span class="pre">ScalarUDF</span></a></span></span></dt> <dd><p>Create a new User-Defined Function (UDF).</p> -<p>This class can be used both as a <strong>function</strong> and as a <strong>decorator</strong>.</p> +<p>This class can be used both as either a function or a decorator.</p> <dl class="simple"> <dt>Usage:</dt><dd><ul class="simple"> -<li><p><strong>As a function</strong>: Call <cite>udf(func, input_types, return_type, volatility, -name)</cite>.</p></li> -<li><p><strong>As a decorator</strong>: Use <cite>@udf(input_types, return_type, volatility, -name)</cite>. In this case, do <strong>not</strong> pass <cite>func</cite> explicitly.</p></li> +<li><p>As a function: <code class="docutils literal notranslate"><span class="pre">udf(func,</span> <span class="pre">input_types,</span> <span class="pre">return_type,</span> <span class="pre">volatility,</span> <span class="pre">name)</span></code>.</p></li> +<li><p>As a decorator: <code class="docutils literal notranslate"><span class="pre">@udf(input_types,</span> <span class="pre">return_type,</span> <span class="pre">volatility,</span> <span class="pre">name)</span></code>. +When used a decorator, do <strong>not</strong> pass <code class="docutils literal notranslate"><span class="pre">func</span></code> explicitly.</p></li> </ul> </dd> </dl> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>func</strong> (<em>Callable</em><em>, </em><em>optional</em>) – <strong>Only needed when calling as a function.</strong> -Skip this argument when using <cite>udf</cite> as a decorator.</p></li> +<li><p><strong>func</strong> (<em>Callable</em><em>, </em><em>optional</em>) – Only needed when calling as a function. +Skip this argument when using <code class="docutils literal notranslate"><span class="pre">udf</span></code> as a decorator.</p></li> <li><p><strong>input_types</strong> (<em>list</em><em>[</em><em>pa.DataType</em><em>]</em>) – The data types of the arguments -to <cite>func</cite>. This list must be of the same length as the number of +to <code class="docutils literal notranslate"><span class="pre">func</span></code>. This list must be of the same length as the number of arguments.</p></li> <li><p><strong>return_type</strong> (<em>_R</em>) – The data type of the return value from the function.</p></li> -<li><p><strong>volatility</strong> (<a class="reference internal" href="udf/index.html#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><em>Volatility</em></a><em> | </em><em>str</em>) – See <cite>Volatility</cite> for allowed values.</p></li> +<li><p><strong>volatility</strong> (<a class="reference internal" href="user_defined/index.html#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><em>Volatility</em></a><em> | </em><em>str</em>) – See <cite>Volatility</cite> for allowed values.</p></li> <li><p><strong>name</strong> (<em>Optional</em><em>[</em><em>str</em><em>]</em>) – A descriptive name for the function.</p></li> </ul> </dd> @@ -3130,24 +4245,19 @@ data aggregation, or window function calls.</p> </dd> </dl> -<p class="rubric">Example</p> -<p><strong>Using `udf` as a function:</strong> -<a href="#id17"><span class="problematic" id="id18">``</span></a>` -def double_func(x):</p> -<blockquote> -<div><p>return x * 2</p> -</div></blockquote> -<p>double_udf = udf(double_func, [pa.int32()], pa.int32(), -“volatile”, “double_it”) -<a href="#id19"><span class="problematic" id="id20">``</span></a><a href="#id21"><span class="problematic" id="id22">`</span></a></p> -<p><strong>Using `udf` as a decorator:</strong> -<a href="#id23"><span class="problematic" id="id24">``</span></a>` -@udf([pa.int32()], pa.int32(), “volatile”, “double_it”) -def double_udf(x):</p> -<blockquote> -<div><p>return x * 2</p> -</div></blockquote> -<p><a href="#id25"><span class="problematic" id="id26">``</span></a><a href="#id27"><span class="problematic" id="id28">`</span></a></p> +<p>Example: Using <code class="docutils literal notranslate"><span class="pre">udf</span></code> as a function:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">double_func</span><span class="p">(</span><span class="n">x</span><span class="p">):</span> + <span class="k">return</span> <span class="n">x</span> <span class="o">*</span> <span class="mi">2</span> +<span class="n">double_udf</span> <span class="o">=</span> <span class="n">udf</span><span class="p">(</span><span class="n">double_func</span><span class="p">,</span> <span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">int32</span><span class="p">()],</span> <span class="n">pa</span><span class="o">.</span><span class="n">int32</span><span class="p">(),</span> +<span class="s2">"volatile"</span><span class="p">,</span> <span class="s2">"double_it"</span><span class="p">)</span> +</pre></div> +</div> +<p>Example: Using <code class="docutils literal notranslate"><span class="pre">udf</span></code> as a decorator:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@udf</span><span class="p">([</span><span class="n">pa</span><span class="o">.</span><span class="n">int32</span><span class="p">()],</span> <span class="n">pa</span><span class="o">.</span><span class="n">int32</span><span class="p">(),</span> <span class="s2">"volatile"</span><span class="p">,</span> <span class="s2">"double_it"</span><span class="p">)</span> +<span class="k">def</span><span class="w"> </span><span class="nf">double_udf</span><span class="p">(</span><span class="n">x</span><span class="p">):</span> + <span class="k">return</span> <span class="n">x</span> <span class="o">*</span> <span class="mi">2</span> +</pre></div> +</div> </dd></dl> <dl class="py attribute"> @@ -3390,6 +4500,54 @@ </dd></dl> <dl class="py class"> +<dt class="sig sig-object py" id="datafusion.TableFunction"> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.</span></span><span class="sig-name descname"><span class="pre">TableFunction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.TableFunction" title="Link to this definition">¶</a></dt> +<dd><p>Class for performing user-defined table functions (UDTF).</p> +<p>Table functions generate new table providers based on the +input expressions.</p> +<p>Instantiate a user-defined table function (UDTF).</p> +<p>See <a class="reference internal" href="#datafusion.udtf" title="datafusion.udtf"><code class="xref py py-func docutils literal notranslate"><span class="pre">udtf()</span></code></a> for a convenience function and argument +descriptions.</p> +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.TableFunction.__call__"> +<span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Any</span></span></span><a class="headerlink" href="#datafusion.TableFunction.__call__" title="Link to this definition">¶</a></dt> +<dd><p>Execute the UDTF and return a table provider.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.TableFunction.__repr__"> +<span class="sig-name descname"><span class="pre">__repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.TableFunction.__repr__" title="Link to this definition">¶</a></dt> +<dd><p>User printable representation.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.TableFunction._create_table_udf"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_create_table_udf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.TableFunction" title="datafusion.TableFunction"><span class="pre">TableFunction</span></a></span></span><a class="headerlink" href="#datafusion.TableFunction._create_table_udf" title="Link to this definition">¶</a></dt> +<dd><p>Create a TableFunction instance from function arguments.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.TableFunction._create_table_udf_decorator"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_create_table_udf_decorator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="user_defined/index.html#datafusion.user_defined.WindowEvaluator" title="datafusion.user_defined.WindowEvaluator"><span class="pre">WindowEvaluator</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.TableFunction._create_table_udf_decorator" title="Link to this definition">¶</a></dt> +<dd><p>Create a decorator for a WindowUDF.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.TableFunction.udtf"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udtf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.TableFunction.udtf" title="Link to this definition">¶</a></dt> +<dt class="sig sig-object py"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udtf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.TableFunction" title="datafusion.TableFunction"><span class="pre">TableFunction</span></a></span></span></dt> +<dd><p>Create a new User-Defined Table Function (UDTF).</p> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.TableFunction._udtf"> +<span class="sig-name descname"><span class="pre">_udtf</span></span><a class="headerlink" href="#datafusion.TableFunction._udtf" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +</dd></dl> + +<dl class="py class"> <dt class="sig sig-object py" id="datafusion.WindowFrame"> <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.</span></span><span class="sig-name descname"><span class="pre">WindowFrame</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">units</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_bound</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_bound</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.WindowFrame" title="Link to this definition">¶</a></dt> <dd><p>Defines a window frame for performing window operations.</p> @@ -3434,7 +4592,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datafusion.WindowUDF"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.</span></span><span class="sig-name descname"><span class="pre">WindowUDF</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="udf/index.html#datafusion.udf.WindowEvaluator" title="datafusion.udf.WindowEvaluator"><span class="pre">WindowEvaluator</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="udf/index.html#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.WindowUDF" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.</span></span><span class="sig-name descname"><span class="pre">WindowUDF</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="user_defined/index.html#datafusion.user_defined.WindowEvaluator" title="datafusion.user_defined.WindowEvaluator"><span class="pre">WindowEvaluator</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="user_defined/index.html#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.WindowUDF" title="Link to this definition">¶</a></dt> <dd><p>Class for performing window user-defined functions (UDF).</p> <p>Window UDFs operate on a partition of rows. See also <a class="reference internal" href="#datafusion.ScalarUDF" title="datafusion.ScalarUDF"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScalarUDF</span></code></a> for operating on a row by row basis.</p> @@ -3451,13 +4609,13 @@ <dl class="py method"> <dt class="sig sig-object py" id="datafusion.WindowUDF._create_window_udf"> -<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_create_window_udf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="udf/index.html#datafusion.udf.WindowEvaluator" title="datafusion.udf.WindowEvaluator"><span class="pre">WindowEvaluator</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="udf/index.html#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.WindowUDF" title="datafusion.WindowUDF"><span class="pre">WindowUDF</span></a></span></span><a class="headerlink" href="#datafusion.WindowUDF._create_window_udf" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_create_window_udf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="user_defined/index.html#datafusion.user_defined.WindowEvaluator" title="datafusion.user_defined.WindowEvaluator"><span class="pre">WindowEvaluator</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="user_defined/index.html#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.WindowUDF" title="datafusion.WindowUDF"><span class="pre">WindowUDF</span></a></span></span><a class="headerlink" href="#datafusion.WindowUDF._create_window_udf" title="Link to this definition">¶</a></dt> <dd><p>Create a WindowUDF instance from function arguments.</p> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="datafusion.WindowUDF._create_window_udf_decorator"> -<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_create_window_udf_decorator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="udf/index.html#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="udf/index.html#datafusion.udf.WindowEvaluator" title="datafusion.udf.WindowEvaluator"><span class="pre">WindowEvaluator</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.WindowUDF._create_window_udf_decorator" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_create_window_udf_decorator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="user_defined/index.html#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="user_defined/index.html#datafusion.user_defined.WindowEvaluator" title="datafusion.user_defined.WindowEvaluator"><span class="pre">WindowEvaluator</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.WindowUDF._create_window_udf_decorator" title="Link to this definition">¶</a></dt> <dd><p>Create a decorator for a WindowUDF.</p> </dd></dl> @@ -3475,53 +4633,49 @@ <dl class="py method"> <dt class="sig sig-object py" id="datafusion.WindowUDF.udwf"> -<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udwf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="udf/index.html#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.WindowUDF" title="datafusion.WindowUDF"><span class="pre">WindowUDF</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.WindowUDF.udwf" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udwf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="user_defined/index.html#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.WindowUDF" title="datafusion.WindowUDF"><span class="pre">WindowUDF</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.WindowUDF.udwf" title="Link to this definition">¶</a></dt> <dt class="sig sig-object py"> -<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udwf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="udf/index.html#datafusion.udf.WindowEvaluator" title="datafusion.udf.WindowEvaluator"><span class="pre">WindowEvaluator</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="udf/index.html#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.WindowUDF" title="datafusion.WindowUDF"><span class="pre">WindowUDF</span></a></span></span></dt> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udwf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="user_defined/index.html#datafusion.user_defined.WindowEvaluator" title="datafusion.user_defined.WindowEvaluator"><span class="pre">WindowEvaluator</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="user_defined/index.html#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.WindowUDF" title="datafusion.WindowUDF"><span class="pre">WindowUDF</span></a></span></span></dt> <dd><p>Create a new User-Defined Window Function (UDWF).</p> -<p>This class can be used both as a <strong>function</strong> and as a <strong>decorator</strong>.</p> -<dl> +<p>This class can be used both as either a function or a decorator.</p> +<dl class="simple"> <dt>Usage:</dt><dd><ul class="simple"> -<li><p><strong>As a function</strong>: Call <cite>udwf(func, input_types, return_type, volatility, -name)</cite>.</p></li> -<li><p><strong>As a decorator</strong>: Use <cite>@udwf(input_types, return_type, volatility, -name)</cite>. When using <cite>udwf</cite> as a decorator, <strong>do not pass `func` -explicitly</strong>.</p></li> +<li><p>As a function: <code class="docutils literal notranslate"><span class="pre">udwf(func,</span> <span class="pre">input_types,</span> <span class="pre">return_type,</span> <span class="pre">volatility,</span> <span class="pre">name)</span></code>.</p></li> +<li><p>As a decorator: <code class="docutils literal notranslate"><span class="pre">@udwf(input_types,</span> <span class="pre">return_type,</span> <span class="pre">volatility,</span> <span class="pre">name)</span></code>. +When using <code class="docutils literal notranslate"><span class="pre">udwf</span></code> as a decorator, do not pass <code class="docutils literal notranslate"><span class="pre">func</span></code> explicitly.</p></li> </ul> </dd> -<dt><strong>Function example:</strong></dt><dd><p><a href="#id29"><span class="problematic" id="id30">``</span></a>` -import pyarrow as pa</p> -<dl class="simple"> -<dt>class BiasedNumbers(WindowEvaluator):</dt><dd><dl class="simple"> -<dt>def __init__(self, start: int = 0) -> None:</dt><dd><p>self.start = start</p> -</dd> -<dt>def evaluate_all(self, values: list[pa.Array],</dt><dd><p>num_rows: int) -> pa.Array: -return pa.array([self.start + i for i in range(num_rows)])</p> -</dd> </dl> -</dd> -<dt>def bias_10() -> BiasedNumbers:</dt><dd><p>return BiasedNumbers(10)</p> -</dd> -</dl> -<p>udwf1 = udwf(BiasedNumbers, pa.int64(), pa.int64(), “immutable”) -udwf2 = udwf(bias_10, pa.int64(), pa.int64(), “immutable”) -udwf3 = udwf(lambda: BiasedNumbers(20), pa.int64(), pa.int64(), “immutable”)</p> -<p><a href="#id31"><span class="problematic" id="id32">``</span></a><a href="#id33"><span class="problematic" id="id34">`</span></a></p> -</dd> -<dt><strong>Decorator example:</strong></dt><dd><p><a href="#id35"><span class="problematic" id="id36">``</span></a>` -@udwf(pa.int64(), pa.int64(), “immutable”) -def biased_numbers() -> BiasedNumbers:</p> -<blockquote> -<div><p>return BiasedNumbers(10)</p> -</div></blockquote> -<p><a href="#id37"><span class="problematic" id="id38">``</span></a><a href="#id39"><span class="problematic" id="id40">`</span></a></p> -</dd> -</dl> +<p>Function example:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">pyarrow</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">pa</span> + +<span class="k">class</span><span class="w"> </span><span class="nc">BiasedNumbers</span><span class="p">(</span><span class="n">WindowEvaluator</span><span class="p">):</span> + <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">start</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> + <span class="bp">self</span><span class="o">.</span><span class="n">start</span> <span class="o">=</span> <span class="n">start</span> + + <span class="k">def</span><span class="w"> </span><span class="nf">evaluate_all</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">values</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">Array</span><span class="p">],</span> + <span class="n">num_rows</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-></span> <span class="n">pa</span><span class="o">.</span><span class="n">Array</span><span class="p">:</span> + <span class="k">return</span> <span class="n">pa</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="bp">self</span><span class="o">.</span><span class="n">start</span> <span class="o">+</span> <span class="n">i</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">num_rows</span><span class="p">)])</span> + +<span class="k">def</span><span class="w"> </span><span class="nf">bias_10</span><span class="p">()</span> <span class="o">-></span> <span class="n">BiasedNumbers</span><span class="p">:</span> + <span class="k">return</span> <span class="n">BiasedNumbers</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span> + +<span class="n">udwf1</span> <span class="o">=</span> <span class="n">udwf</span><span class="p">(</span><span class="n">BiasedNumbers</span><span class="p">,</span> <span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span> <span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span> <span class="s2">"immutable"</span><span class="p">)</span> +<span class="n">udwf2</span> <span class="o">=</span> <span class="n">udwf</span><span class="p">(</span><span class="n">bias_10</span><span class="p">,</span> <span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span> <span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span> <span class="s2">"immutable"</span><span class="p">)</span> +<span class="n">udwf3</span> <span class="o">=</span> <span class="n">udwf</span><span class="p">(</span><span class="k">lambda</span><span class="p">:</span> <span class="n">BiasedNumbers</span><span class="p">(</span><span class="mi">20</span><span class="p">),</span> <span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span> <span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span> <span class="s2">"immutable"</span><span class="p">)</span> +</pre></div> +</div> +<p>Decorator example:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@udwf</span><span class="p">(</span><span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span> <span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span> <span class="s2">"immutable"</span><span class="p">)</span> +<span class="k">def</span><span class="w"> </span><span class="nf">biased_numbers</span><span class="p">()</span> <span class="o">-></span> <span class="n">BiasedNumbers</span><span class="p">:</span> + <span class="k">return</span> <span class="n">BiasedNumbers</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span> +</pre></div> +</div> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>func</strong> – <strong>Only needed when calling as a function. Skip this argument when -using `udwf` as a decorator.</strong></p></li> +<li><p><strong>func</strong> – Only needed when calling as a function. Skip this argument when +using <code class="docutils literal notranslate"><span class="pre">udwf</span></code> as a decorator.</p></li> <li><p><strong>input_types</strong> – The data types of the arguments.</p></li> <li><p><strong>return_type</strong> – The data type of the return value.</p></li> <li><p><strong>volatility</strong> – See <code class="xref py py-class docutils literal notranslate"><span class="pre">Volatility</span></code> for allowed values.</p></li> @@ -3542,15 +4696,30 @@ </dd></dl> <dl class="py function"> -<dt class="sig sig-object py" id="datafusion.col"> -<span class="sig-prename descclassname"><span class="pre">datafusion.</span></span><span class="sig-name descname"><span class="pre">col</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">expr.Expr</span></a></span></span><a class="headerlink" href="#datafusion.col" title="Link to this definition">¶</a></dt> -<dd><p>Create a column expression.</p> -</dd></dl> - -<dl class="py function"> -<dt class="sig sig-object py" id="datafusion.column"> -<span class="sig-prename descclassname"><span class="pre">datafusion.</span></span><span class="sig-name descname"><span class="pre">column</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">expr.Expr</span></a></span></span><a class="headerlink" href="#datafusion.column" title="Link to this definition">¶</a></dt> -<dd><p>Create a column expression.</p> +<dt class="sig sig-object py" id="datafusion.configure_formatter"> +<span class="sig-prename descclassname"><span class="pre">datafusion.</span></span><span class="sig-name descname"><span class="pre">configure_formatter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.configure_formatter" title="Link to this definition">¶</a></dt> +<dd><p>Configure the global DataFrame HTML formatter.</p> +<p>This function creates a new formatter with the provided configuration +and sets it as the global formatter for all DataFrames.</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><p><strong>**kwargs</strong> – Formatter configuration parameters like max_cell_length, +max_width, max_height, enable_cell_expansion, etc.</p> +</dd> +<dt class="field-even">Raises<span class="colon">:</span></dt> +<dd class="field-even"><p><strong>ValueError</strong> – If any invalid parameters are provided</p> +</dd> +</dl> +<p class="rubric">Example</p> +<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">datafusion.html_formatter</span><span class="w"> </span><span class="kn">import</span> <span class="n">configure_formatter</span> +<span class="gp">>>> </span><span class="n">configure_formatter</span><span class="p">(</span> +<span class="gp">... </span> <span class="n">max_cell_length</span><span class="o">=</span><span class="mi">50</span><span class="p">,</span> +<span class="gp">... </span> <span class="n">max_height</span><span class="o">=</span><span class="mi">500</span><span class="p">,</span> +<span class="gp">... </span> <span class="n">enable_cell_expansion</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> +<span class="gp">... </span> <span class="n">use_shared_styles</span><span class="o">=</span><span class="kc">True</span> +<span class="gp">... </span><span class="p">)</span> +</pre></div> +</div> </dd></dl> <dl class="py function"> @@ -3681,6 +4850,16 @@ <dd></dd></dl> <dl class="py data"> +<dt class="sig sig-object py" id="datafusion.col"> +<span class="sig-prename descclassname"><span class="pre">datafusion.</span></span><span class="sig-name descname"><span class="pre">col</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Col</span></em><a class="headerlink" href="#datafusion.col" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.column"> +<span class="sig-prename descclassname"><span class="pre">datafusion.</span></span><span class="sig-name descname"><span class="pre">column</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Col</span></em><a class="headerlink" href="#datafusion.column" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> <dt class="sig sig-object py" id="datafusion.udaf"> <span class="sig-prename descclassname"><span class="pre">datafusion.</span></span><span class="sig-name descname"><span class="pre">udaf</span></span><a class="headerlink" href="#datafusion.udaf" title="Link to this definition">¶</a></dt> <dd></dd></dl> @@ -3691,6 +4870,11 @@ <dd></dd></dl> <dl class="py data"> +<dt class="sig sig-object py" id="datafusion.udtf"> +<span class="sig-prename descclassname"><span class="pre">datafusion.</span></span><span class="sig-name descname"><span class="pre">udtf</span></span><a class="headerlink" href="#datafusion.udtf" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> <dt class="sig sig-object py" id="datafusion.udwf"> <span class="sig-prename descclassname"><span class="pre">datafusion.</span></span><span class="sig-name descname"><span class="pre">udwf</span></span><a class="headerlink" href="#datafusion.udwf" title="Link to this definition">¶</a></dt> <dd></dd></dl>
diff --git a/autoapi/datafusion/input/base/index.html b/autoapi/datafusion/input/base/index.html index 5c55d0b..b7958e5 100644 --- a/autoapi/datafusion/input/base/index.html +++ b/autoapi/datafusion/input/base/index.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../../user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../user-guide/common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../../col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../../context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/autoapi/datafusion/input/index.html b/autoapi/datafusion/input/index.html index 1f36814..299228a 100644 --- a/autoapi/datafusion/input/index.html +++ b/autoapi/datafusion/input/index.html
@@ -35,7 +35,7 @@ <link rel="index" title="Index" href="../../../genindex.html" /> <link rel="search" title="Search" href="../../../search.html" /> <link rel="next" title="datafusion.input.base" href="base/index.html" /> - <link rel="prev" title="datafusion.functions" href="../functions/index.html" /> + <link rel="prev" title="datafusion.html_formatter" href="../html_formatter/index.html" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="docsearch:language" content="en"> @@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../user-guide/common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul> @@ -496,11 +521,11 @@ <!-- Previous / next buttons --> <div class='prev-next-area'> - <a class='left-prev' id="prev-link" href="../functions/index.html" title="previous page"> + <a class='left-prev' id="prev-link" href="../html_formatter/index.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> - <p class="prev-next-title">datafusion.functions</p> + <p class="prev-next-title">datafusion.html_formatter</p> </div> </a> <a class='right-next' id="next-link" href="base/index.html" title="next page">
diff --git a/autoapi/datafusion/input/location/index.html b/autoapi/datafusion/input/location/index.html index 2be4274..f0890e2 100644 --- a/autoapi/datafusion/input/location/index.html +++ b/autoapi/datafusion/input/location/index.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../../user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../user-guide/common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../../col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../../context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/autoapi/datafusion/io/index.html b/autoapi/datafusion/io/index.html index 3ce9435..726ec26 100644 --- a/autoapi/datafusion/io/index.html +++ b/autoapi/datafusion/io/index.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../user-guide/common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/autoapi/datafusion/object_store/index.html b/autoapi/datafusion/object_store/index.html index b27718f..d3a249f 100644 --- a/autoapi/datafusion/object_store/index.html +++ b/autoapi/datafusion/object_store/index.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../user-guide/common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/autoapi/datafusion/plan/index.html b/autoapi/datafusion/plan/index.html index df79d85..bfb7072 100644 --- a/autoapi/datafusion/plan/index.html +++ b/autoapi/datafusion/plan/index.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../user-guide/common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/autoapi/datafusion/record_batch/index.html b/autoapi/datafusion/record_batch/index.html index edeb5af..3db4e2b 100644 --- a/autoapi/datafusion/record_batch/index.html +++ b/autoapi/datafusion/record_batch/index.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../user-guide/common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/autoapi/datafusion/substrait/index.html b/autoapi/datafusion/substrait/index.html index 87028da..9443e48 100644 --- a/autoapi/datafusion/substrait/index.html +++ b/autoapi/datafusion/substrait/index.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../user-guide/common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/autoapi/datafusion/udf/index.html b/autoapi/datafusion/udf/index.html index 9f0f674..a6ff5e1 100644 --- a/autoapi/datafusion/udf/index.html +++ b/autoapi/datafusion/udf/index.html
@@ -34,6 +34,7 @@ <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script> <link rel="index" title="Index" href="../../../genindex.html" /> <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="datafusion.unparser" href="../unparser/index.html" /> <link rel="prev" title="datafusion.substrait" href="../substrait/index.html" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="docsearch:language" content="en"> @@ -116,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../user-guide/common-operations/index.html"> Common Operations @@ -275,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../context/index.html"> datafusion.context </a> @@ -294,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../input/index.html"> datafusion.input @@ -346,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul> @@ -368,403 +394,9 @@ <div class="toc-item"> -<div class="tocsection onthispage pt-5 pb-3"> - <i class="fas fa-list"></i> On this page -</div> <nav id="bd-toc-nav"> - <ul class="visible nav section-nav flex-column"> - <li class="toc-h2 nav-item toc-entry"> - <a class="reference internal nav-link" href="#attributes"> - Attributes - </a> - </li> - <li class="toc-h2 nav-item toc-entry"> - <a class="reference internal nav-link" href="#classes"> - Classes - </a> - </li> - <li class="toc-h2 nav-item toc-entry"> - <a class="reference internal nav-link" href="#module-contents"> - Module Contents - </a> - <ul class="visible nav section-nav flex-column"> - <li class="toc-h3 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.Accumulator"> - <code class="docutils literal notranslate"> - <span class="pre"> - Accumulator - </span> - </code> - </a> - <ul class="nav section-nav flex-column"> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.Accumulator.evaluate"> - <code class="docutils literal notranslate"> - <span class="pre"> - Accumulator.evaluate() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.Accumulator.merge"> - <code class="docutils literal notranslate"> - <span class="pre"> - Accumulator.merge() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.Accumulator.state"> - <code class="docutils literal notranslate"> - <span class="pre"> - Accumulator.state() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.Accumulator.update"> - <code class="docutils literal notranslate"> - <span class="pre"> - Accumulator.update() - </span> - </code> - </a> - </li> - </ul> - </li> - <li class="toc-h3 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.AggregateUDF"> - <code class="docutils literal notranslate"> - <span class="pre"> - AggregateUDF - </span> - </code> - </a> - <ul class="nav section-nav flex-column"> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.AggregateUDF.__call__"> - <code class="docutils literal notranslate"> - <span class="pre"> - AggregateUDF.__call__() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.AggregateUDF.udaf"> - <code class="docutils literal notranslate"> - <span class="pre"> - AggregateUDF.udaf() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.AggregateUDF._udaf"> - <code class="docutils literal notranslate"> - <span class="pre"> - AggregateUDF._udaf - </span> - </code> - </a> - </li> - </ul> - </li> - <li class="toc-h3 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.ScalarUDF"> - <code class="docutils literal notranslate"> - <span class="pre"> - ScalarUDF - </span> - </code> - </a> - <ul class="nav section-nav flex-column"> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.ScalarUDF.__call__"> - <code class="docutils literal notranslate"> - <span class="pre"> - ScalarUDF.__call__() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.ScalarUDF.udf"> - <code class="docutils literal notranslate"> - <span class="pre"> - ScalarUDF.udf() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.ScalarUDF._udf"> - <code class="docutils literal notranslate"> - <span class="pre"> - ScalarUDF._udf - </span> - </code> - </a> - </li> - </ul> - </li> - <li class="toc-h3 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.Volatility"> - <code class="docutils literal notranslate"> - <span class="pre"> - Volatility - </span> - </code> - </a> - <ul class="nav section-nav flex-column"> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.Volatility.__str__"> - <code class="docutils literal notranslate"> - <span class="pre"> - Volatility.__str__() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.Volatility.Immutable"> - <code class="docutils literal notranslate"> - <span class="pre"> - Volatility.Immutable - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.Volatility.Stable"> - <code class="docutils literal notranslate"> - <span class="pre"> - Volatility.Stable - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.Volatility.Volatile"> - <code class="docutils literal notranslate"> - <span class="pre"> - Volatility.Volatile - </span> - </code> - </a> - </li> - </ul> - </li> - <li class="toc-h3 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.WindowEvaluator"> - <code class="docutils literal notranslate"> - <span class="pre"> - WindowEvaluator - </span> - </code> - </a> - <ul class="nav section-nav flex-column"> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.WindowEvaluator.evaluate"> - <code class="docutils literal notranslate"> - <span class="pre"> - WindowEvaluator.evaluate() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.WindowEvaluator.evaluate_all"> - <code class="docutils literal notranslate"> - <span class="pre"> - WindowEvaluator.evaluate_all() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.WindowEvaluator.evaluate_all_with_rank"> - <code class="docutils literal notranslate"> - <span class="pre"> - WindowEvaluator.evaluate_all_with_rank() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.WindowEvaluator.get_range"> - <code class="docutils literal notranslate"> - <span class="pre"> - WindowEvaluator.get_range() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.WindowEvaluator.include_rank"> - <code class="docutils literal notranslate"> - <span class="pre"> - WindowEvaluator.include_rank() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.WindowEvaluator.is_causal"> - <code class="docutils literal notranslate"> - <span class="pre"> - WindowEvaluator.is_causal() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.WindowEvaluator.memoize"> - <code class="docutils literal notranslate"> - <span class="pre"> - WindowEvaluator.memoize() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.WindowEvaluator.supports_bounded_execution"> - <code class="docutils literal notranslate"> - <span class="pre"> - WindowEvaluator.supports_bounded_execution() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.WindowEvaluator.uses_window_frame"> - <code class="docutils literal notranslate"> - <span class="pre"> - WindowEvaluator.uses_window_frame() - </span> - </code> - </a> - </li> - </ul> - </li> - <li class="toc-h3 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.WindowUDF"> - <code class="docutils literal notranslate"> - <span class="pre"> - WindowUDF - </span> - </code> - </a> - <ul class="nav section-nav flex-column"> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.WindowUDF.__call__"> - <code class="docutils literal notranslate"> - <span class="pre"> - WindowUDF.__call__() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.WindowUDF._create_window_udf"> - <code class="docutils literal notranslate"> - <span class="pre"> - WindowUDF._create_window_udf() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.WindowUDF._create_window_udf_decorator"> - <code class="docutils literal notranslate"> - <span class="pre"> - WindowUDF._create_window_udf_decorator() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.WindowUDF._get_default_name"> - <code class="docutils literal notranslate"> - <span class="pre"> - WindowUDF._get_default_name() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.WindowUDF._normalize_input_types"> - <code class="docutils literal notranslate"> - <span class="pre"> - WindowUDF._normalize_input_types() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.WindowUDF.udwf"> - <code class="docutils literal notranslate"> - <span class="pre"> - WindowUDF.udwf() - </span> - </code> - </a> - </li> - <li class="toc-h4 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.WindowUDF._udwf"> - <code class="docutils literal notranslate"> - <span class="pre"> - WindowUDF._udwf - </span> - </code> - </a> - </li> - </ul> - </li> - <li class="toc-h3 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf._R"> - <code class="docutils literal notranslate"> - <span class="pre"> - _R - </span> - </code> - </a> - </li> - <li class="toc-h3 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.udaf"> - <code class="docutils literal notranslate"> - <span class="pre"> - udaf - </span> - </code> - </a> - </li> - <li class="toc-h3 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.udf"> - <code class="docutils literal notranslate"> - <span class="pre"> - udf - </span> - </code> - </a> - </li> - <li class="toc-h3 nav-item toc-entry"> - <a class="reference internal nav-link" href="#datafusion.udf.udwf"> - <code class="docutils literal notranslate"> - <span class="pre"> - udwf - </span> - </code> - </a> - </li> - </ul> - </li> -</ul> - + </nav> </div> @@ -786,627 +418,7 @@ <section id="module-datafusion.udf"> <span id="datafusion-udf"></span><h1>datafusion.udf<a class="headerlink" href="#module-datafusion.udf" title="Link to this heading">¶</a></h1> -<p>Provides the user-defined functions for evaluation of dataframes.</p> -<section id="attributes"> -<h2>Attributes<a class="headerlink" href="#attributes" title="Link to this heading">¶</a></h2> -<table class="autosummary longtable table autosummary"> -<tbody> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.udf._R" title="datafusion.udf._R"><code class="xref py py-obj docutils literal notranslate"><span class="pre">_R</span></code></a></p></td> -<td><p></p></td> -</tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.udf.udaf" title="datafusion.udf.udaf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">udaf</span></code></a></p></td> -<td><p></p></td> -</tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.udf.udf" title="datafusion.udf.udf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">udf</span></code></a></p></td> -<td><p></p></td> -</tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.udf.udwf" title="datafusion.udf.udwf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">udwf</span></code></a></p></td> -<td><p></p></td> -</tr> -</tbody> -</table> -</section> -<section id="classes"> -<h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶</a></h2> -<table class="autosummary longtable table autosummary"> -<tbody> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.udf.Accumulator" title="datafusion.udf.Accumulator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Accumulator</span></code></a></p></td> -<td><p>Defines how an <a class="reference internal" href="#datafusion.udf.AggregateUDF" title="datafusion.udf.AggregateUDF"><code class="xref py py-class docutils literal notranslate"><span class="pre">AggregateUDF</span></code></a> accumulates values.</p></td> -</tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.udf.AggregateUDF" title="datafusion.udf.AggregateUDF"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AggregateUDF</span></code></a></p></td> -<td><p>Class for performing scalar user-defined functions (UDF).</p></td> -</tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.udf.ScalarUDF" title="datafusion.udf.ScalarUDF"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ScalarUDF</span></code></a></p></td> -<td><p>Class for performing scalar user-defined functions (UDF).</p></td> -</tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Volatility</span></code></a></p></td> -<td><p>Defines how stable or volatile a function is.</p></td> -</tr> -<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.udf.WindowEvaluator" title="datafusion.udf.WindowEvaluator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">WindowEvaluator</span></code></a></p></td> -<td><p>Evaluator class for user-defined window functions (UDWF).</p></td> -</tr> -<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.udf.WindowUDF" title="datafusion.udf.WindowUDF"><code class="xref py py-obj docutils literal notranslate"><span class="pre">WindowUDF</span></code></a></p></td> -<td><p>Class for performing window user-defined functions (UDF).</p></td> -</tr> -</tbody> -</table> -</section> -<section id="module-contents"> -<h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to this heading">¶</a></h2> -<dl class="py class"> -<dt class="sig sig-object py" id="datafusion.udf.Accumulator"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.udf.</span></span><span class="sig-name descname"><span class="pre">Accumulator</span></span><a class="headerlink" href="#datafusion.udf.Accumulator" title="Link to this definition">¶</a></dt> -<dd><p>Defines how an <a class="reference internal" href="#datafusion.udf.AggregateUDF" title="datafusion.udf.AggregateUDF"><code class="xref py py-class docutils literal notranslate"><span class="pre">AggregateUDF</span></code></a> accumulates values.</p> -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.Accumulator.evaluate"> -<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">evaluate</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pyarrow.Scalar</span></span></span><a class="headerlink" href="#datafusion.udf.Accumulator.evaluate" title="Link to this definition">¶</a></dt> -<dd><p>Return the resultant value.</p> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.Accumulator.merge"> -<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">states</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.Array</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.udf.Accumulator.merge" title="Link to this definition">¶</a></dt> -<dd><p>Merge a set of states.</p> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.Accumulator.state"> -<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">state</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.Scalar</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.udf.Accumulator.state" title="Link to this definition">¶</a></dt> -<dd><p>Return the current state.</p> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.Accumulator.update"> -<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.Array</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.udf.Accumulator.update" title="Link to this definition">¶</a></dt> -<dd><p>Evaluate an array of values and update state.</p> -</dd></dl> - -</dd></dl> - -<dl class="py class"> -<dt class="sig sig-object py" id="datafusion.udf.AggregateUDF"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.udf.</span></span><span class="sig-name descname"><span class="pre">AggregateUDF</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">accumulator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.udf.Accumulator" title="datafusion.udf.Accumulator"><span class="pre">Accumulator</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.udf.AggregateUDF" title="Link to this definition">¶</a></dt> -<dd><p>Class for performing scalar user-defined functions (UDF).</p> -<p>Aggregate UDFs operate on a group of rows and return a single value. See -also <a class="reference internal" href="#datafusion.udf.ScalarUDF" title="datafusion.udf.ScalarUDF"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScalarUDF</span></code></a> for operating on a row by row basis.</p> -<p>Instantiate a user-defined aggregate function (UDAF).</p> -<p>See <a class="reference internal" href="#datafusion.udf.udaf" title="datafusion.udf.udaf"><code class="xref py py-func docutils literal notranslate"><span class="pre">udaf()</span></code></a> for a convenience function and argument -descriptions.</p> -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.AggregateUDF.__call__"> -<span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a></span></span><a class="headerlink" href="#datafusion.udf.AggregateUDF.__call__" title="Link to this definition">¶</a></dt> -<dd><p>Execute the UDAF.</p> -<p>This function is not typically called by an end user. These calls will -occur during the evaluation of the dataframe.</p> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.AggregateUDF.udaf"> -<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udaf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.udf.AggregateUDF" title="datafusion.udf.AggregateUDF"><span class="pre">AggregateUDF</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.udf.AggregateUDF.udaf" title="Link to this definition">¶</a></dt> -<dt class="sig sig-object py"> -<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udaf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">accum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.udf.Accumulator" title="datafusion.udf.Accumulator"><span class="pre">Accumulator</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.udf.AggregateUDF" title="datafusion.udf.AggregateUDF"><span class="pre">AggregateUDF</span></a></span></span></dt> -<dd><p>Create a new User-Defined Aggregate Function (UDAF).</p> -<p>This class allows you to define an <strong>aggregate function</strong> that can be used in -data aggregation or window function calls.</p> -<dl> -<dt>Usage:</dt><dd><ul class="simple"> -<li><dl class="simple"> -<dt><strong>As a function</strong>: Call <a href="#id1"><span class="problematic" id="id2">`</span></a>udaf(accum, input_types, return_type, state_type,</dt><dd><p>volatility, name)`.</p> -</dd> -</dl> -</li> -<li><dl class="simple"> -<dt><strong>As a decorator</strong>: Use <a href="#id3"><span class="problematic" id="id4">`</span></a>@udaf(input_types, return_type, state_type,</dt><dd><p>volatility, name)`.</p> -</dd> -</dl> -</li> -</ul> -<p>When using <cite>udaf</cite> as a decorator, <strong>do not pass `accum` explicitly</strong>.</p> -</dd> -</dl> -<p><strong>Function example:</strong></p> -<blockquote> -<div><p>If your <cite>:py:class:Accumulator</cite> can be instantiated with no arguments, you -can simply pass it’s type as <cite>accum</cite>. If you need to pass additional -arguments to it’s constructor, you can define a lambda or a factory method. -During runtime the <cite>:py:class:Accumulator</cite> will be constructed for every -instance in which this UDAF is used. The following examples are all valid. -<a href="#id5"><span class="problematic" id="id6">``</span></a>` -import pyarrow as pa -import pyarrow.compute as pc</p> -<dl class="simple"> -<dt>class Summarize(Accumulator):</dt><dd><dl class="simple"> -<dt>def __init__(self, bias: float = 0.0):</dt><dd><p>self._sum = pa.scalar(bias)</p> -</dd> -<dt>def state(self) -> list[pa.Scalar]:</dt><dd><p>return [self._sum]</p> -</dd> -<dt>def update(self, values: pa.Array) -> None:</dt><dd><p>self._sum = pa.scalar(self._sum.as_py() + pc.sum(values).as_py())</p> -</dd> -<dt>def merge(self, states: list[pa.Array]) -> None:</dt><dd><p>self._sum = pa.scalar(self._sum.as_py() + pc.sum(states[0]).as_py())</p> -</dd> -<dt>def evaluate(self) -> pa.Scalar:</dt><dd><p>return self._sum</p> -</dd> -</dl> -</dd> -<dt>def sum_bias_10() -> Summarize:</dt><dd><p>return Summarize(10.0)</p> -</dd> -<dt>udaf1 = udaf(Summarize, pa.float64(), pa.float64(), [pa.float64()],</dt><dd><p>“immutable”)</p> -</dd> -<dt>udaf2 = udaf(sum_bias_10, pa.float64(), pa.float64(), [pa.float64()],</dt><dd><p>“immutable”)</p> -</dd> -<dt>udaf3 = udaf(lambda: Summarize(20.0), pa.float64(), pa.float64(),</dt><dd><p>[pa.float64()], “immutable”)</p> -</dd> -</dl> -<p><a href="#id7"><span class="problematic" id="id8">``</span></a><a href="#id9"><span class="problematic" id="id10">`</span></a></p> -</div></blockquote> -<dl> -<dt><strong>Decorator example:</strong></dt><dd><p><a href="#id11"><span class="problematic" id="id12">``</span></a>` -@udaf(pa.float64(), pa.float64(), [pa.float64()], “immutable”) -def udf4() -> Summarize:</p> -<blockquote> -<div><p>return Summarize(10.0)</p> -</div></blockquote> -<p><a href="#id13"><span class="problematic" id="id14">``</span></a><a href="#id15"><span class="problematic" id="id16">`</span></a></p> -</dd> -</dl> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>accum</strong> – The accumulator python function. <strong>Only needed when calling as a -function. Skip this argument when using `udaf` as a decorator.</strong></p></li> -<li><p><strong>input_types</strong> – The data types of the arguments to <code class="docutils literal notranslate"><span class="pre">accum</span></code>.</p></li> -<li><p><strong>return_type</strong> – The data type of the return value.</p></li> -<li><p><strong>state_type</strong> – The data types of the intermediate accumulation.</p></li> -<li><p><strong>volatility</strong> – See <a class="reference internal" href="#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><code class="xref py py-class docutils literal notranslate"><span class="pre">Volatility</span></code></a> for allowed values.</p></li> -<li><p><strong>name</strong> – A descriptive name for the function.</p></li> -</ul> -</dd> -<dt class="field-even">Returns<span class="colon">:</span></dt> -<dd class="field-even"><p>A user-defined aggregate function, which can be used in either data -aggregation or window function calls.</p> -</dd> -</dl> -</dd></dl> - -<dl class="py attribute"> -<dt class="sig sig-object py" id="datafusion.udf.AggregateUDF._udaf"> -<span class="sig-name descname"><span class="pre">_udaf</span></span><a class="headerlink" href="#datafusion.udf.AggregateUDF._udaf" title="Link to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="py class"> -<dt class="sig sig-object py" id="datafusion.udf.ScalarUDF"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.udf.</span></span><span class="sig-name descname"><span class="pre">ScalarUDF</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">_R</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">_R</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.udf.ScalarUDF" title="Link to this definition">¶</a></dt> -<dd><p>Class for performing scalar user-defined functions (UDF).</p> -<p>Scalar UDFs operate on a row by row basis. See also <a class="reference internal" href="#datafusion.udf.AggregateUDF" title="datafusion.udf.AggregateUDF"><code class="xref py py-class docutils literal notranslate"><span class="pre">AggregateUDF</span></code></a> for -operating on a group of rows.</p> -<p>Instantiate a scalar user-defined function (UDF).</p> -<p>See helper method <a class="reference internal" href="#datafusion.udf.udf" title="datafusion.udf.udf"><code class="xref py py-func docutils literal notranslate"><span class="pre">udf()</span></code></a> for argument details.</p> -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.ScalarUDF.__call__"> -<span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a></span></span><a class="headerlink" href="#datafusion.udf.ScalarUDF.__call__" title="Link to this definition">¶</a></dt> -<dd><p>Execute the UDF.</p> -<p>This function is not typically called by an end user. These calls will -occur during the evaluation of the dataframe.</p> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.ScalarUDF.udf"> -<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">_R</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.udf.ScalarUDF" title="datafusion.udf.ScalarUDF"><span class="pre">ScalarUDF</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.udf.ScalarUDF.udf" title="Link to this definition">¶</a></dt> -<dt class="sig sig-object py"> -<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">_R</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">_R</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.udf.ScalarUDF" title="datafusion.udf.ScalarUDF"><span class="pre">ScalarUDF</span></a></span></span></dt> -<dd><p>Create a new User-Defined Function (UDF).</p> -<p>This class can be used both as a <strong>function</strong> and as a <strong>decorator</strong>.</p> -<dl class="simple"> -<dt>Usage:</dt><dd><ul class="simple"> -<li><p><strong>As a function</strong>: Call <cite>udf(func, input_types, return_type, volatility, -name)</cite>.</p></li> -<li><p><strong>As a decorator</strong>: Use <cite>@udf(input_types, return_type, volatility, -name)</cite>. In this case, do <strong>not</strong> pass <cite>func</cite> explicitly.</p></li> -</ul> -</dd> -</dl> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>func</strong> (<em>Callable</em><em>, </em><em>optional</em>) – <strong>Only needed when calling as a function.</strong> -Skip this argument when using <cite>udf</cite> as a decorator.</p></li> -<li><p><strong>input_types</strong> (<em>list</em><em>[</em><em>pa.DataType</em><em>]</em>) – The data types of the arguments -to <cite>func</cite>. This list must be of the same length as the number of -arguments.</p></li> -<li><p><strong>return_type</strong> (<em>_R</em>) – The data type of the return value from the function.</p></li> -<li><p><strong>volatility</strong> (<a class="reference internal" href="#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><em>Volatility</em></a><em> | </em><em>str</em>) – See <cite>Volatility</cite> for allowed values.</p></li> -<li><p><strong>name</strong> (<em>Optional</em><em>[</em><em>str</em><em>]</em>) – A descriptive name for the function.</p></li> -</ul> -</dd> -<dt class="field-even">Returns<span class="colon">:</span></dt> -<dd class="field-even"><p>A user-defined function that can be used in SQL expressions, -data aggregation, or window function calls.</p> -</dd> -</dl> -<p class="rubric">Example</p> -<p><strong>Using `udf` as a function:</strong> -<a href="#id17"><span class="problematic" id="id18">``</span></a>` -def double_func(x):</p> -<blockquote> -<div><p>return x * 2</p> -</div></blockquote> -<p>double_udf = udf(double_func, [pa.int32()], pa.int32(), -“volatile”, “double_it”) -<a href="#id19"><span class="problematic" id="id20">``</span></a><a href="#id21"><span class="problematic" id="id22">`</span></a></p> -<p><strong>Using `udf` as a decorator:</strong> -<a href="#id23"><span class="problematic" id="id24">``</span></a>` -@udf([pa.int32()], pa.int32(), “volatile”, “double_it”) -def double_udf(x):</p> -<blockquote> -<div><p>return x * 2</p> -</div></blockquote> -<p><a href="#id25"><span class="problematic" id="id26">``</span></a><a href="#id27"><span class="problematic" id="id28">`</span></a></p> -</dd></dl> - -<dl class="py attribute"> -<dt class="sig sig-object py" id="datafusion.udf.ScalarUDF._udf"> -<span class="sig-name descname"><span class="pre">_udf</span></span><a class="headerlink" href="#datafusion.udf.ScalarUDF._udf" title="Link to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="py class"> -<dt class="sig sig-object py" id="datafusion.udf.Volatility"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.udf.</span></span><span class="sig-name descname"><span class="pre">Volatility</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwds</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.udf.Volatility" title="Link to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">enum.Enum</span></code></p> -<p>Defines how stable or volatile a function is.</p> -<p>When setting the volatility of a function, you can either pass this -enumeration or a <code class="docutils literal notranslate"><span class="pre">str</span></code>. The <code class="docutils literal notranslate"><span class="pre">str</span></code> equivalent is the lower case value of the -name (<cite>“immutable”</cite>, <cite>“stable”</cite>, or <cite>“volatile”</cite>).</p> -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.Volatility.__str__"> -<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.udf.Volatility.__str__" title="Link to this definition">¶</a></dt> -<dd><p>Returns the string equivalent.</p> -</dd></dl> - -<dl class="py attribute"> -<dt class="sig sig-object py" id="datafusion.udf.Volatility.Immutable"> -<span class="sig-name descname"><span class="pre">Immutable</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#datafusion.udf.Volatility.Immutable" title="Link to this definition">¶</a></dt> -<dd><p>An immutable function will always return the same output when given the -same input.</p> -<p>DataFusion will attempt to inline immutable functions during planning.</p> -</dd></dl> - -<dl class="py attribute"> -<dt class="sig sig-object py" id="datafusion.udf.Volatility.Stable"> -<span class="sig-name descname"><span class="pre">Stable</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#datafusion.udf.Volatility.Stable" title="Link to this definition">¶</a></dt> -<dd><p>Returns the same value for a given input within a single queries.</p> -<p>A stable function may return different values given the same input across -different queries but must return the same value for a given input within a -query. An example of this is the <code class="docutils literal notranslate"><span class="pre">Now</span></code> function. DataFusion will attempt to -inline <code class="docutils literal notranslate"><span class="pre">Stable</span></code> functions during planning, when possible. For query -<code class="docutils literal notranslate"><span class="pre">select</span> <span class="pre">col1,</span> <span class="pre">now()</span> <span class="pre">from</span> <span class="pre">t1</span></code>, it might take a while to execute but <code class="docutils literal notranslate"><span class="pre">now()</span></code> -column will be the same for each output row, which is evaluated during -planning.</p> -</dd></dl> - -<dl class="py attribute"> -<dt class="sig sig-object py" id="datafusion.udf.Volatility.Volatile"> -<span class="sig-name descname"><span class="pre">Volatile</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#datafusion.udf.Volatility.Volatile" title="Link to this definition">¶</a></dt> -<dd><p>A volatile function may change the return value from evaluation to -evaluation.</p> -<p>Multiple invocations of a volatile function may return different results -when used in the same query. An example of this is the random() function. -DataFusion can not evaluate such functions during planning. In the query -<code class="docutils literal notranslate"><span class="pre">select</span> <span class="pre">col1,</span> <span class="pre">random()</span> <span class="pre">from</span> <span class="pre">t1</span></code>, <code class="docutils literal notranslate"><span class="pre">random()</span></code> function will be evaluated -for each output row, resulting in a unique random value for each row.</p> -</dd></dl> - -</dd></dl> - -<dl class="py class"> -<dt class="sig sig-object py" id="datafusion.udf.WindowEvaluator"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.udf.</span></span><span class="sig-name descname"><span class="pre">WindowEvaluator</span></span><a class="headerlink" href="#datafusion.udf.WindowEvaluator" title="Link to this definition">¶</a></dt> -<dd><p>Evaluator class for user-defined window functions (UDWF).</p> -<p>It is up to the user to decide which evaluate function is appropriate.</p> -<table class="table"> -<thead> -<tr class="row-odd"><th class="head"><p><code class="docutils literal notranslate"><span class="pre">uses_window_frame</span></code></p></th> -<th class="head"><p><code class="docutils literal notranslate"><span class="pre">supports_bounded_execution</span></code></p></th> -<th class="head"><p><code class="docutils literal notranslate"><span class="pre">include_rank</span></code></p></th> -<th class="head"><p>function_to_implement</p></th> -</tr> -</thead> -<tbody> -<tr class="row-even"><td><p>False (default)</p></td> -<td><p>False (default)</p></td> -<td><p>False (default)</p></td> -<td><p><code class="docutils literal notranslate"><span class="pre">evaluate_all</span></code></p></td> -</tr> -<tr class="row-odd"><td><p>False</p></td> -<td><p>True</p></td> -<td><p>False</p></td> -<td><p><code class="docutils literal notranslate"><span class="pre">evaluate</span></code></p></td> -</tr> -<tr class="row-even"><td><p>False</p></td> -<td><p>True/False</p></td> -<td><p>True</p></td> -<td><p><code class="docutils literal notranslate"><span class="pre">evaluate_all_with_rank</span></code></p></td> -</tr> -<tr class="row-odd"><td><p>True</p></td> -<td><p>True/False</p></td> -<td><p>True/False</p></td> -<td><p><code class="docutils literal notranslate"><span class="pre">evaluate</span></code></p></td> -</tr> -</tbody> -</table> -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.WindowEvaluator.evaluate"> -<span class="sig-name descname"><span class="pre">evaluate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.Array</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eval_range</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pyarrow.Scalar</span></span></span><a class="headerlink" href="#datafusion.udf.WindowEvaluator.evaluate" title="Link to this definition">¶</a></dt> -<dd><p>Evaluate window function on a range of rows in an input partition.</p> -<p>This is the simplest and most general function to implement -but also the least performant as it creates output one row at -a time. It is typically much faster to implement stateful -evaluation using one of the other specialized methods on this -trait.</p> -<p>Returns a [<cite>ScalarValue</cite>] that is the value of the window -function within <cite>range</cite> for the entire partition. Argument -<cite>values</cite> contains the evaluation result of function arguments -and evaluation results of ORDER BY expressions. If function has a -single argument, <cite>values[1..]</cite> will contain ORDER BY expression results.</p> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.WindowEvaluator.evaluate_all"> -<span class="sig-name descname"><span class="pre">evaluate_all</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.Array</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_rows</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pyarrow.Array</span></span></span><a class="headerlink" href="#datafusion.udf.WindowEvaluator.evaluate_all" title="Link to this definition">¶</a></dt> -<dd><p>Evaluate a window function on an entire input partition.</p> -<p>This function is called once per input <em>partition</em> for window functions that -<em>do not use</em> values from the window frame, such as -<a class="reference internal" href="../functions/index.html#datafusion.functions.row_number" title="datafusion.functions.row_number"><code class="xref py py-func docutils literal notranslate"><span class="pre">row_number()</span></code></a>, -<a class="reference internal" href="../functions/index.html#datafusion.functions.rank" title="datafusion.functions.rank"><code class="xref py py-func docutils literal notranslate"><span class="pre">rank()</span></code></a>, -<a class="reference internal" href="../functions/index.html#datafusion.functions.dense_rank" title="datafusion.functions.dense_rank"><code class="xref py py-func docutils literal notranslate"><span class="pre">dense_rank()</span></code></a>, -<a class="reference internal" href="../functions/index.html#datafusion.functions.percent_rank" title="datafusion.functions.percent_rank"><code class="xref py py-func docutils literal notranslate"><span class="pre">percent_rank()</span></code></a>, -<a class="reference internal" href="../functions/index.html#datafusion.functions.cume_dist" title="datafusion.functions.cume_dist"><code class="xref py py-func docutils literal notranslate"><span class="pre">cume_dist()</span></code></a>, -<a class="reference internal" href="../functions/index.html#datafusion.functions.lead" title="datafusion.functions.lead"><code class="xref py py-func docutils literal notranslate"><span class="pre">lead()</span></code></a>, -and <a class="reference internal" href="../functions/index.html#datafusion.functions.lag" title="datafusion.functions.lag"><code class="xref py py-func docutils literal notranslate"><span class="pre">lag()</span></code></a>.</p> -<p>It produces the result of all rows in a single pass. It -expects to receive the entire partition as the <code class="docutils literal notranslate"><span class="pre">value</span></code> and -must produce an output column with one output row for every -input row.</p> -<p><code class="docutils literal notranslate"><span class="pre">num_rows</span></code> is required to correctly compute the output in case -<code class="docutils literal notranslate"><span class="pre">len(values)</span> <span class="pre">==</span> <span class="pre">0</span></code></p> -<p>Implementing this function is an optimization. Certain window -functions are not affected by the window frame definition or -the query doesn’t have a frame, and <code class="docutils literal notranslate"><span class="pre">evaluate</span></code> skips the -(costly) window frame boundary calculation and the overhead of -calling <code class="docutils literal notranslate"><span class="pre">evaluate</span></code> for each output row.</p> -<p>For example, the <cite>LAG</cite> built in window function does not use -the values of its window frame (it can be computed in one shot -on the entire partition with <code class="docutils literal notranslate"><span class="pre">Self::evaluate_all</span></code> regardless of the -window defined in the <code class="docutils literal notranslate"><span class="pre">OVER</span></code> clause)</p> -<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>lag(x, 1) OVER (ORDER BY z ROWS BETWEEN 2 PRECEDING AND 3 FOLLOWING) -</pre></div> -</div> -<p>However, <code class="docutils literal notranslate"><span class="pre">avg()</span></code> computes the average in the window and thus -does use its window frame.</p> -<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>avg(x) OVER (PARTITION BY y ORDER BY z ROWS BETWEEN 2 PRECEDING AND 3 FOLLOWING) -</pre></div> -</div> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.WindowEvaluator.evaluate_all_with_rank"> -<span class="sig-name descname"><span class="pre">evaluate_all_with_rank</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_rows</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ranks_in_partition</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pyarrow.Array</span></span></span><a class="headerlink" href="#datafusion.udf.WindowEvaluator.evaluate_all_with_rank" title="Link to this definition">¶</a></dt> -<dd><p>Called for window functions that only need the rank of a row.</p> -<p>Evaluate the partition evaluator against the partition using -the row ranks. For example, <code class="docutils literal notranslate"><span class="pre">rank(col("a"))</span></code> produces</p> -<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>a | rank -- + ---- -A | 1 -A | 1 -C | 3 -D | 4 -D | 4 -</pre></div> -</div> -<p>For this case, <cite>num_rows</cite> would be <cite>5</cite> and the -<cite>ranks_in_partition</cite> would be called with</p> -<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>[ - (0,1), - (2,2), - (3,4), -] -</pre></div> -</div> -<p>The user must implement this method if <code class="docutils literal notranslate"><span class="pre">include_rank</span></code> returns True.</p> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.WindowEvaluator.get_range"> -<span class="sig-name descname"><span class="pre">get_range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">idx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_rows</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.udf.WindowEvaluator.get_range" title="Link to this definition">¶</a></dt> -<dd><p>Return the range for the window fuction.</p> -<p>If <cite>uses_window_frame</cite> flag is <cite>false</cite>. This method is used to -calculate required range for the window function during -stateful execution.</p> -<p>Generally there is no required range, hence by default this -returns smallest range(current row). e.g seeing current row is -enough to calculate window result (such as row_number, rank, -etc)</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>idx:</strong> – Current index:</p></li> -<li><p><strong>num_rows</strong> – Number of rows.</p></li> -</ul> -</dd> -</dl> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.WindowEvaluator.include_rank"> -<span class="sig-name descname"><span class="pre">include_rank</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datafusion.udf.WindowEvaluator.include_rank" title="Link to this definition">¶</a></dt> -<dd><p>Can this function be evaluated with (only) rank?</p> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.WindowEvaluator.is_causal"> -<span class="sig-name descname"><span class="pre">is_causal</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datafusion.udf.WindowEvaluator.is_causal" title="Link to this definition">¶</a></dt> -<dd><p>Get whether evaluator needs future data for its result.</p> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.WindowEvaluator.memoize"> -<span class="sig-name descname"><span class="pre">memoize</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.udf.WindowEvaluator.memoize" title="Link to this definition">¶</a></dt> -<dd><p>Perform a memoize operation to improve performance.</p> -<p>When the window frame has a fixed beginning (e.g UNBOUNDED -PRECEDING), some functions such as FIRST_VALUE and -NTH_VALUE do not need the (unbounded) input once they have -seen a certain amount of input.</p> -<p><cite>memoize</cite> is called after each input batch is processed, and -such functions can save whatever they need</p> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.WindowEvaluator.supports_bounded_execution"> -<span class="sig-name descname"><span class="pre">supports_bounded_execution</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datafusion.udf.WindowEvaluator.supports_bounded_execution" title="Link to this definition">¶</a></dt> -<dd><p>Can the window function be incrementally computed using bounded memory?</p> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.WindowEvaluator.uses_window_frame"> -<span class="sig-name descname"><span class="pre">uses_window_frame</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datafusion.udf.WindowEvaluator.uses_window_frame" title="Link to this definition">¶</a></dt> -<dd><p>Does the window function use the values from the window frame?</p> -</dd></dl> - -</dd></dl> - -<dl class="py class"> -<dt class="sig sig-object py" id="datafusion.udf.WindowUDF"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.udf.</span></span><span class="sig-name descname"><span class="pre">WindowUDF</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.udf.WindowEvaluator" title="datafusion.udf.WindowEvaluator"><span class="pre">WindowEvaluator</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.udf.WindowUDF" title="Link to this definition">¶</a></dt> -<dd><p>Class for performing window user-defined functions (UDF).</p> -<p>Window UDFs operate on a partition of rows. See -also <a class="reference internal" href="#datafusion.udf.ScalarUDF" title="datafusion.udf.ScalarUDF"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScalarUDF</span></code></a> for operating on a row by row basis.</p> -<p>Instantiate a user-defined window function (UDWF).</p> -<p>See <a class="reference internal" href="#datafusion.udf.udwf" title="datafusion.udf.udwf"><code class="xref py py-func docutils literal notranslate"><span class="pre">udwf()</span></code></a> for a convenience function and argument -descriptions.</p> -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.WindowUDF.__call__"> -<span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a></span></span><a class="headerlink" href="#datafusion.udf.WindowUDF.__call__" title="Link to this definition">¶</a></dt> -<dd><p>Execute the UDWF.</p> -<p>This function is not typically called by an end user. These calls will -occur during the evaluation of the dataframe.</p> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.WindowUDF._create_window_udf"> -<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_create_window_udf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.udf.WindowEvaluator" title="datafusion.udf.WindowEvaluator"><span class="pre">WindowEvaluator</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.udf.WindowUDF" title="datafusion.udf.WindowUDF"><span class="pre">WindowUDF</span></a></span></span><a class="headerlink" href="#datafusion.udf.WindowUDF._create_window_udf" title="Link to this definition">¶</a></dt> -<dd><p>Create a WindowUDF instance from function arguments.</p> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.WindowUDF._create_window_udf_decorator"> -<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_create_window_udf_decorator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.udf.WindowEvaluator" title="datafusion.udf.WindowEvaluator"><span class="pre">WindowEvaluator</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.udf.WindowUDF._create_window_udf_decorator" title="Link to this definition">¶</a></dt> -<dd><p>Create a decorator for a WindowUDF.</p> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.WindowUDF._get_default_name"> -<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_get_default_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.udf.WindowUDF._get_default_name" title="Link to this definition">¶</a></dt> -<dd><p>Get the default name for a function based on its attributes.</p> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.WindowUDF._normalize_input_types"> -<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_normalize_input_types</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.udf.WindowUDF._normalize_input_types" title="Link to this definition">¶</a></dt> -<dd><p>Convert a single DataType to a list if needed.</p> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="datafusion.udf.WindowUDF.udwf"> -<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udwf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.udf.WindowUDF" title="datafusion.udf.WindowUDF"><span class="pre">WindowUDF</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.udf.WindowUDF.udwf" title="Link to this definition">¶</a></dt> -<dt class="sig sig-object py"> -<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udwf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.udf.WindowEvaluator" title="datafusion.udf.WindowEvaluator"><span class="pre">WindowEvaluator</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.udf.WindowUDF" title="datafusion.udf.WindowUDF"><span class="pre">WindowUDF</span></a></span></span></dt> -<dd><p>Create a new User-Defined Window Function (UDWF).</p> -<p>This class can be used both as a <strong>function</strong> and as a <strong>decorator</strong>.</p> -<dl> -<dt>Usage:</dt><dd><ul class="simple"> -<li><p><strong>As a function</strong>: Call <cite>udwf(func, input_types, return_type, volatility, -name)</cite>.</p></li> -<li><p><strong>As a decorator</strong>: Use <cite>@udwf(input_types, return_type, volatility, -name)</cite>. When using <cite>udwf</cite> as a decorator, <strong>do not pass `func` -explicitly</strong>.</p></li> -</ul> -</dd> -<dt><strong>Function example:</strong></dt><dd><p><a href="#id29"><span class="problematic" id="id30">``</span></a>` -import pyarrow as pa</p> -<dl class="simple"> -<dt>class BiasedNumbers(WindowEvaluator):</dt><dd><dl class="simple"> -<dt>def __init__(self, start: int = 0) -> None:</dt><dd><p>self.start = start</p> -</dd> -<dt>def evaluate_all(self, values: list[pa.Array],</dt><dd><p>num_rows: int) -> pa.Array: -return pa.array([self.start + i for i in range(num_rows)])</p> -</dd> -</dl> -</dd> -<dt>def bias_10() -> BiasedNumbers:</dt><dd><p>return BiasedNumbers(10)</p> -</dd> -</dl> -<p>udwf1 = udwf(BiasedNumbers, pa.int64(), pa.int64(), “immutable”) -udwf2 = udwf(bias_10, pa.int64(), pa.int64(), “immutable”) -udwf3 = udwf(lambda: BiasedNumbers(20), pa.int64(), pa.int64(), “immutable”)</p> -<p><a href="#id31"><span class="problematic" id="id32">``</span></a><a href="#id33"><span class="problematic" id="id34">`</span></a></p> -</dd> -<dt><strong>Decorator example:</strong></dt><dd><p><a href="#id35"><span class="problematic" id="id36">``</span></a>` -@udwf(pa.int64(), pa.int64(), “immutable”) -def biased_numbers() -> BiasedNumbers:</p> -<blockquote> -<div><p>return BiasedNumbers(10)</p> -</div></blockquote> -<p><a href="#id37"><span class="problematic" id="id38">``</span></a><a href="#id39"><span class="problematic" id="id40">`</span></a></p> -</dd> -</dl> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>func</strong> – <strong>Only needed when calling as a function. Skip this argument when -using `udwf` as a decorator.</strong></p></li> -<li><p><strong>input_types</strong> – The data types of the arguments.</p></li> -<li><p><strong>return_type</strong> – The data type of the return value.</p></li> -<li><p><strong>volatility</strong> – See <a class="reference internal" href="#datafusion.udf.Volatility" title="datafusion.udf.Volatility"><code class="xref py py-class docutils literal notranslate"><span class="pre">Volatility</span></code></a> for allowed values.</p></li> -<li><p><strong>name</strong> – A descriptive name for the function.</p></li> -</ul> -</dd> -<dt class="field-even">Returns<span class="colon">:</span></dt> -<dd class="field-even"><p>A user-defined window function that can be used in window function calls.</p> -</dd> -</dl> -</dd></dl> - -<dl class="py attribute"> -<dt class="sig sig-object py" id="datafusion.udf.WindowUDF._udwf"> -<span class="sig-name descname"><span class="pre">_udwf</span></span><a class="headerlink" href="#datafusion.udf.WindowUDF._udwf" title="Link to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="py data"> -<dt class="sig sig-object py" id="datafusion.udf._R"> -<span class="sig-prename descclassname"><span class="pre">datafusion.udf.</span></span><span class="sig-name descname"><span class="pre">_R</span></span><a class="headerlink" href="#datafusion.udf._R" title="Link to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="py data"> -<dt class="sig sig-object py" id="datafusion.udf.udaf"> -<span class="sig-prename descclassname"><span class="pre">datafusion.udf.</span></span><span class="sig-name descname"><span class="pre">udaf</span></span><a class="headerlink" href="#datafusion.udf.udaf" title="Link to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="py data"> -<dt class="sig sig-object py" id="datafusion.udf.udf"> -<span class="sig-prename descclassname"><span class="pre">datafusion.udf.</span></span><span class="sig-name descname"><span class="pre">udf</span></span><a class="headerlink" href="#datafusion.udf.udf" title="Link to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="py data"> -<dt class="sig sig-object py" id="datafusion.udf.udwf"> -<span class="sig-prename descclassname"><span class="pre">datafusion.udf.</span></span><span class="sig-name descname"><span class="pre">udwf</span></span><a class="headerlink" href="#datafusion.udf.udwf" title="Link to this definition">¶</a></dt> -<dd></dd></dl> - -</section> +<p>Deprecated module for user defined functions.</p> </section> @@ -1422,6 +434,13 @@ <p class="prev-next-title">datafusion.substrait</p> </div> </a> + <a class='right-next' id="next-link" href="../unparser/index.html" title="next page"> + <div class="prev-next-info"> + <p class="prev-next-subtitle">next</p> + <p class="prev-next-title">datafusion.unparser</p> + </div> + <i class="fas fa-angle-right"></i> + </a> </div> </main>
diff --git a/autoapi/datafusion/unparser/index.html b/autoapi/datafusion/unparser/index.html new file mode 100644 index 0000000..33d59e0 --- /dev/null +++ b/autoapi/datafusion/unparser/index.html
@@ -0,0 +1,682 @@ +<!DOCTYPE html> + +<html lang="en" data-content_root="../../../"> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> + + <title>datafusion.unparser — Apache Arrow DataFusion documentation</title> + + <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> +<link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> + + + <link rel="stylesheet" + href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> + <link rel="preload" as="font" type="font/woff2" crossorigin + href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> + <link rel="preload" as="font" type="font/woff2" crossorigin + href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> + + + + + + <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=8f2a1f02" /> + <link rel="stylesheet" type="text/css" href="../../../_static/styles/pydata-sphinx-theme.css?v=1140d252" /> + <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=4ae1632d" /> + <link rel="stylesheet" type="text/css" href="../../../_static/theme_overrides.css?v=dca7052a" /> + + <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> + + <script src="../../../_static/documentation_options.js?v=8a448e45"></script> + <script src="../../../_static/doctools.js?v=9bcbadda"></script> + <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="datafusion.user_defined" href="../user_defined/index.html" /> + <link rel="prev" title="datafusion.udf" href="../udf/index.html" /> + <meta name="viewport" content="width=device-width, initial-scale=1" /> + <meta name="docsearch:language" content="en"> + + + <!-- Google Analytics --> + + </head> + <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80"> + + <div class="container-fluid" id="banner"></div> + + + + + <div class="container-xl"> + <div class="row"> + + + <!-- Only show if we have sidebars configured, else just a small margin --> + <div class="col-12 col-md-3 bd-sidebar"> + <div class="sidebar-start-items"> +<a class="navbar-brand" href="../../../index.html"> + <img src="../../../_static/images/2x_bgwhite_original.png" class="logo" alt="logo"> +</a> + +<form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> + <i class="icon fas fa-search"></i> + <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" > +</form> + +<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation"> + <div class="bd-toc-item active"> + + <p aria-level="2" class="caption" role="heading"> + <span class="caption-text"> + LINKS + </span> +</p> +<ul class="nav bd-sidenav"> + <li class="toctree-l1"> + <a class="reference external" href="https://github.com/apache/datafusion-python"> + Github and Issue Tracker + </a> + </li> + <li class="toctree-l1"> + <a class="reference external" href="https://docs.rs/datafusion/latest/datafusion/"> + Rust's API Docs + </a> + </li> + <li class="toctree-l1"> + <a class="reference external" href="https://github.com/apache/datafusion/blob/main/CODE_OF_CONDUCT.md"> + Code of conduct + </a> + </li> + <li class="toctree-l1"> + <a class="reference external" href="https://github.com/apache/datafusion-python/tree/main/examples"> + Examples + </a> + </li> +</ul> +<p aria-level="2" class="caption" role="heading"> + <span class="caption-text"> + USER GUIDE + </span> +</p> +<ul class="nav bd-sidenav"> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/introduction.html"> + Introduction + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/basics.html"> + Concepts + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/data-sources.html"> + Data Sources + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/dataframe.html"> + DataFrames + </a> + </li> + <li class="toctree-l1 has-children"> + <a class="reference internal" href="../../../user-guide/common-operations/index.html"> + Common Operations + </a> + <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/> + <label for="toctree-checkbox-1"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/views.html"> + Registering Views + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/basic-info.html"> + Basic Operations + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/select-and-filter.html"> + Column Selections + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/expressions.html"> + Expressions + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/joins.html"> + Joins + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/functions.html"> + Functions + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/aggregations.html"> + Aggregation + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/windows.html"> + Window Functions + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/udf-and-udfa.html"> + User-Defined Functions + </a> + </li> + </ul> + </li> + <li class="toctree-l1 has-children"> + <a class="reference internal" href="../../../user-guide/io/index.html"> + IO + </a> + <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/> + <label for="toctree-checkbox-2"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/arrow.html"> + Arrow + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/avro.html"> + Avro + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/csv.html"> + CSV + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/json.html"> + JSON + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/parquet.html"> + Parquet + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/table_provider.html"> + Custom Table Provider + </a> + </li> + </ul> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/configuration.html"> + Configuration + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/sql.html"> + SQL + </a> + </li> +</ul> +<p aria-level="2" class="caption" role="heading"> + <span class="caption-text"> + CONTRIBUTOR GUIDE + </span> +</p> +<ul class="nav bd-sidenav"> + <li class="toctree-l1"> + <a class="reference internal" href="../../../contributor-guide/introduction.html"> + Introduction + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../contributor-guide/ffi.html"> + Python Extensions + </a> + </li> +</ul> +<p aria-level="2" class="caption" role="heading"> + <span class="caption-text"> + API + </span> +</p> +<ul class="current nav bd-sidenav"> + <li class="toctree-l1 current active has-children"> + <a class="reference internal" href="../../index.html"> + API Reference + </a> + <input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/> + <label for="toctree-checkbox-3"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul class="current"> + <li class="toctree-l2 current active has-children"> + <a class="reference internal" href="../index.html"> + datafusion + </a> + <input checked="" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/> + <label for="toctree-checkbox-4"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul class="current"> + <li class="toctree-l3"> + <a class="reference internal" href="../catalog/index.html"> + datafusion.catalog + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../context/index.html"> + datafusion.context + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../dataframe/index.html"> + datafusion.dataframe + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../expr/index.html"> + datafusion.expr + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../functions/index.html"> + datafusion.functions + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> + <li class="toctree-l3 has-children"> + <a class="reference internal" href="../input/index.html"> + datafusion.input + </a> + <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/> + <label for="toctree-checkbox-5"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul> + <li class="toctree-l4"> + <a class="reference internal" href="../input/base/index.html"> + datafusion.input.base + </a> + </li> + <li class="toctree-l4"> + <a class="reference internal" href="../input/location/index.html"> + datafusion.input.location + </a> + </li> + </ul> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../io/index.html"> + datafusion.io + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../object_store/index.html"> + datafusion.object_store + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../plan/index.html"> + datafusion.plan + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../record_batch/index.html"> + datafusion.record_batch + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../substrait/index.html"> + datafusion.substrait + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../udf/index.html"> + datafusion.udf + </a> + </li> + <li class="toctree-l3 current active"> + <a class="current reference internal" href="#"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../user_defined/index.html"> + datafusion.user_defined + </a> + </li> + </ul> + </li> + </ul> + </li> +</ul> + + + </div> +</nav> + </div> + <div class="sidebar-end-items"> + </div> + </div> + + + + + <div class="d-none d-xl-block col-xl-2 bd-toc"> + + + <div class="toc-item"> + +<div class="tocsection onthispage pt-5 pb-3"> + <i class="fas fa-list"></i> On this page +</div> + +<nav id="bd-toc-nav"> + <ul class="visible nav section-nav flex-column"> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#classes"> + Classes + </a> + </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#module-contents"> + Module Contents + </a> + <ul class="visible nav section-nav flex-column"> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.unparser.Dialect"> + <code class="docutils literal notranslate"> + <span class="pre"> + Dialect + </span> + </code> + </a> + <ul class="nav section-nav flex-column"> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.unparser.Dialect.default"> + <code class="docutils literal notranslate"> + <span class="pre"> + Dialect.default() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.unparser.Dialect.duckdb"> + <code class="docutils literal notranslate"> + <span class="pre"> + Dialect.duckdb() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.unparser.Dialect.mysql"> + <code class="docutils literal notranslate"> + <span class="pre"> + Dialect.mysql() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.unparser.Dialect.postgres"> + <code class="docutils literal notranslate"> + <span class="pre"> + Dialect.postgres() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.unparser.Dialect.sqlite"> + <code class="docutils literal notranslate"> + <span class="pre"> + Dialect.sqlite() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.unparser.Dialect.dialect"> + <code class="docutils literal notranslate"> + <span class="pre"> + Dialect.dialect + </span> + </code> + </a> + </li> + </ul> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.unparser.Unparser"> + <code class="docutils literal notranslate"> + <span class="pre"> + Unparser + </span> + </code> + </a> + <ul class="nav section-nav flex-column"> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.unparser.Unparser.plan_to_sql"> + <code class="docutils literal notranslate"> + <span class="pre"> + Unparser.plan_to_sql() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.unparser.Unparser.with_pretty"> + <code class="docutils literal notranslate"> + <span class="pre"> + Unparser.with_pretty() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.unparser.Unparser.unparser"> + <code class="docutils literal notranslate"> + <span class="pre"> + Unparser.unparser + </span> + </code> + </a> + </li> + </ul> + </li> + </ul> + </li> +</ul> + +</nav> + </div> + + <div class="toc-item"> + + </div> + + + </div> + + + + + + + <main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main"> + + <div> + + <section id="module-datafusion.unparser"> +<span id="datafusion-unparser"></span><h1>datafusion.unparser<a class="headerlink" href="#module-datafusion.unparser" title="Link to this heading">¶</a></h1> +<p>This module provides support for unparsing datafusion plans to SQL.</p> +<p>For additional information about unparsing, see <a class="reference external" href="https://docs.rs/datafusion-sql/latest/datafusion_sql/unparser/index.html">https://docs.rs/datafusion-sql/latest/datafusion_sql/unparser/index.html</a></p> +<section id="classes"> +<h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶</a></h2> +<table class="autosummary longtable table autosummary"> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.unparser.Dialect" title="datafusion.unparser.Dialect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Dialect</span></code></a></p></td> +<td><p>DataFusion data catalog.</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.unparser.Unparser" title="datafusion.unparser.Unparser"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Unparser</span></code></a></p></td> +<td><p>DataFusion unparser.</p></td> +</tr> +</tbody> +</table> +</section> +<section id="module-contents"> +<h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to this heading">¶</a></h2> +<dl class="py class"> +<dt class="sig sig-object py" id="datafusion.unparser.Dialect"> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.unparser.</span></span><span class="sig-name descname"><span class="pre">Dialect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dialect</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datafusion._internal.unparser.Dialect</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.unparser.Dialect" title="Link to this definition">¶</a></dt> +<dd><p>DataFusion data catalog.</p> +<p>This constructor is not typically called by the end user.</p> +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.unparser.Dialect.default"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.unparser.Dialect" title="datafusion.unparser.Dialect"><span class="pre">Dialect</span></a></span></span><a class="headerlink" href="#datafusion.unparser.Dialect.default" title="Link to this definition">¶</a></dt> +<dd><p>Create a new default dialect.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.unparser.Dialect.duckdb"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">duckdb</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.unparser.Dialect" title="datafusion.unparser.Dialect"><span class="pre">Dialect</span></a></span></span><a class="headerlink" href="#datafusion.unparser.Dialect.duckdb" title="Link to this definition">¶</a></dt> +<dd><p>Create a new DuckDB dialect.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.unparser.Dialect.mysql"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">mysql</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.unparser.Dialect" title="datafusion.unparser.Dialect"><span class="pre">Dialect</span></a></span></span><a class="headerlink" href="#datafusion.unparser.Dialect.mysql" title="Link to this definition">¶</a></dt> +<dd><p>Create a new MySQL dialect.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.unparser.Dialect.postgres"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">postgres</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.unparser.Dialect" title="datafusion.unparser.Dialect"><span class="pre">Dialect</span></a></span></span><a class="headerlink" href="#datafusion.unparser.Dialect.postgres" title="Link to this definition">¶</a></dt> +<dd><p>Create a new PostgreSQL dialect.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.unparser.Dialect.sqlite"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sqlite</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.unparser.Dialect" title="datafusion.unparser.Dialect"><span class="pre">Dialect</span></a></span></span><a class="headerlink" href="#datafusion.unparser.Dialect.sqlite" title="Link to this definition">¶</a></dt> +<dd><p>Create a new SQLite dialect.</p> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.unparser.Dialect.dialect"> +<span class="sig-name descname"><span class="pre">dialect</span></span><a class="headerlink" href="#datafusion.unparser.Dialect.dialect" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +</dd></dl> + +<dl class="py class"> +<dt class="sig sig-object py" id="datafusion.unparser.Unparser"> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.unparser.</span></span><span class="sig-name descname"><span class="pre">Unparser</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dialect</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.unparser.Dialect" title="datafusion.unparser.Dialect"><span class="pre">Dialect</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.unparser.Unparser" title="Link to this definition">¶</a></dt> +<dd><p>DataFusion unparser.</p> +<p>This constructor is not typically called by the end user.</p> +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.unparser.Unparser.plan_to_sql"> +<span class="sig-name descname"><span class="pre">plan_to_sql</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plan</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../plan/index.html#datafusion.plan.LogicalPlan" title="datafusion.plan.LogicalPlan"><span class="pre">datafusion.plan.LogicalPlan</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.unparser.Unparser.plan_to_sql" title="Link to this definition">¶</a></dt> +<dd><p>Convert a logical plan to a SQL string.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.unparser.Unparser.with_pretty"> +<span class="sig-name descname"><span class="pre">with_pretty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pretty</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.unparser.Unparser" title="datafusion.unparser.Unparser"><span class="pre">Unparser</span></a></span></span><a class="headerlink" href="#datafusion.unparser.Unparser.with_pretty" title="Link to this definition">¶</a></dt> +<dd><p>Set the pretty flag.</p> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.unparser.Unparser.unparser"> +<span class="sig-name descname"><span class="pre">unparser</span></span><a class="headerlink" href="#datafusion.unparser.Unparser.unparser" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +</dd></dl> + +</section> +</section> + + + </div> + + + <!-- Previous / next buttons --> +<div class='prev-next-area'> + <a class='left-prev' id="prev-link" href="../udf/index.html" title="previous page"> + <i class="fas fa-angle-left"></i> + <div class="prev-next-info"> + <p class="prev-next-subtitle">previous</p> + <p class="prev-next-title">datafusion.udf</p> + </div> + </a> + <a class='right-next' id="next-link" href="../user_defined/index.html" title="next page"> + <div class="prev-next-info"> + <p class="prev-next-subtitle">next</p> + <p class="prev-next-title">datafusion.user_defined</p> + </div> + <i class="fas fa-angle-right"></i> + </a> +</div> + + </main> + + + </div> + </div> + + <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> + +<!-- Based on pydata_sphinx_theme/footer.html --> +<footer class="footer mt-5 mt-md-0"> + <div class="container"> + + <div class="footer-item"> + <p class="copyright"> + © Copyright 2019-2024, Apache Software Foundation.<br> +</p> + </div> + + <div class="footer-item"> + <p class="sphinx-version"> +Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.1.3.<br> +</p> + </div> + + <div class="footer-item"> + <p>Apache Arrow DataFusion, Arrow DataFusion, Apache, the Apache feather logo, and the Apache Arrow DataFusion project logo</p> + <p>are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.</p> + </div> + </div> +</footer> + + + </body> +</html> \ No newline at end of file
diff --git a/autoapi/datafusion/user_defined/index.html b/autoapi/datafusion/user_defined/index.html new file mode 100644 index 0000000..40d8f07 --- /dev/null +++ b/autoapi/datafusion/user_defined/index.html
@@ -0,0 +1,1597 @@ +<!DOCTYPE html> + +<html lang="en" data-content_root="../../../"> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> + + <title>datafusion.user_defined — Apache Arrow DataFusion documentation</title> + + <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> +<link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> + + + <link rel="stylesheet" + href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> + <link rel="preload" as="font" type="font/woff2" crossorigin + href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> + <link rel="preload" as="font" type="font/woff2" crossorigin + href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> + + + + + + <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=8f2a1f02" /> + <link rel="stylesheet" type="text/css" href="../../../_static/styles/pydata-sphinx-theme.css?v=1140d252" /> + <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=4ae1632d" /> + <link rel="stylesheet" type="text/css" href="../../../_static/theme_overrides.css?v=dca7052a" /> + + <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> + + <script src="../../../_static/documentation_options.js?v=8a448e45"></script> + <script src="../../../_static/doctools.js?v=9bcbadda"></script> + <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="prev" title="datafusion.unparser" href="../unparser/index.html" /> + <meta name="viewport" content="width=device-width, initial-scale=1" /> + <meta name="docsearch:language" content="en"> + + + <!-- Google Analytics --> + + </head> + <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80"> + + <div class="container-fluid" id="banner"></div> + + + + + <div class="container-xl"> + <div class="row"> + + + <!-- Only show if we have sidebars configured, else just a small margin --> + <div class="col-12 col-md-3 bd-sidebar"> + <div class="sidebar-start-items"> +<a class="navbar-brand" href="../../../index.html"> + <img src="../../../_static/images/2x_bgwhite_original.png" class="logo" alt="logo"> +</a> + +<form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> + <i class="icon fas fa-search"></i> + <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" > +</form> + +<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation"> + <div class="bd-toc-item active"> + + <p aria-level="2" class="caption" role="heading"> + <span class="caption-text"> + LINKS + </span> +</p> +<ul class="nav bd-sidenav"> + <li class="toctree-l1"> + <a class="reference external" href="https://github.com/apache/datafusion-python"> + Github and Issue Tracker + </a> + </li> + <li class="toctree-l1"> + <a class="reference external" href="https://docs.rs/datafusion/latest/datafusion/"> + Rust's API Docs + </a> + </li> + <li class="toctree-l1"> + <a class="reference external" href="https://github.com/apache/datafusion/blob/main/CODE_OF_CONDUCT.md"> + Code of conduct + </a> + </li> + <li class="toctree-l1"> + <a class="reference external" href="https://github.com/apache/datafusion-python/tree/main/examples"> + Examples + </a> + </li> +</ul> +<p aria-level="2" class="caption" role="heading"> + <span class="caption-text"> + USER GUIDE + </span> +</p> +<ul class="nav bd-sidenav"> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/introduction.html"> + Introduction + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/basics.html"> + Concepts + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/data-sources.html"> + Data Sources + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/dataframe.html"> + DataFrames + </a> + </li> + <li class="toctree-l1 has-children"> + <a class="reference internal" href="../../../user-guide/common-operations/index.html"> + Common Operations + </a> + <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/> + <label for="toctree-checkbox-1"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/views.html"> + Registering Views + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/basic-info.html"> + Basic Operations + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/select-and-filter.html"> + Column Selections + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/expressions.html"> + Expressions + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/joins.html"> + Joins + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/functions.html"> + Functions + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/aggregations.html"> + Aggregation + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/windows.html"> + Window Functions + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/common-operations/udf-and-udfa.html"> + User-Defined Functions + </a> + </li> + </ul> + </li> + <li class="toctree-l1 has-children"> + <a class="reference internal" href="../../../user-guide/io/index.html"> + IO + </a> + <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/> + <label for="toctree-checkbox-2"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/arrow.html"> + Arrow + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/avro.html"> + Avro + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/csv.html"> + CSV + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/json.html"> + JSON + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/parquet.html"> + Parquet + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="../../../user-guide/io/table_provider.html"> + Custom Table Provider + </a> + </li> + </ul> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/configuration.html"> + Configuration + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../user-guide/sql.html"> + SQL + </a> + </li> +</ul> +<p aria-level="2" class="caption" role="heading"> + <span class="caption-text"> + CONTRIBUTOR GUIDE + </span> +</p> +<ul class="nav bd-sidenav"> + <li class="toctree-l1"> + <a class="reference internal" href="../../../contributor-guide/introduction.html"> + Introduction + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../../../contributor-guide/ffi.html"> + Python Extensions + </a> + </li> +</ul> +<p aria-level="2" class="caption" role="heading"> + <span class="caption-text"> + API + </span> +</p> +<ul class="current nav bd-sidenav"> + <li class="toctree-l1 current active has-children"> + <a class="reference internal" href="../../index.html"> + API Reference + </a> + <input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/> + <label for="toctree-checkbox-3"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul class="current"> + <li class="toctree-l2 current active has-children"> + <a class="reference internal" href="../index.html"> + datafusion + </a> + <input checked="" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/> + <label for="toctree-checkbox-4"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul class="current"> + <li class="toctree-l3"> + <a class="reference internal" href="../catalog/index.html"> + datafusion.catalog + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../context/index.html"> + datafusion.context + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../dataframe/index.html"> + datafusion.dataframe + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../expr/index.html"> + datafusion.expr + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../functions/index.html"> + datafusion.functions + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> + <li class="toctree-l3 has-children"> + <a class="reference internal" href="../input/index.html"> + datafusion.input + </a> + <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/> + <label for="toctree-checkbox-5"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul> + <li class="toctree-l4"> + <a class="reference internal" href="../input/base/index.html"> + datafusion.input.base + </a> + </li> + <li class="toctree-l4"> + <a class="reference internal" href="../input/location/index.html"> + datafusion.input.location + </a> + </li> + </ul> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../io/index.html"> + datafusion.io + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../object_store/index.html"> + datafusion.object_store + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../plan/index.html"> + datafusion.plan + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../record_batch/index.html"> + datafusion.record_batch + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../substrait/index.html"> + datafusion.substrait + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../udf/index.html"> + datafusion.udf + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3 current active"> + <a class="current reference internal" href="#"> + datafusion.user_defined + </a> + </li> + </ul> + </li> + </ul> + </li> +</ul> + + + </div> +</nav> + </div> + <div class="sidebar-end-items"> + </div> + </div> + + + + + <div class="d-none d-xl-block col-xl-2 bd-toc"> + + + <div class="toc-item"> + +<div class="tocsection onthispage pt-5 pb-3"> + <i class="fas fa-list"></i> On this page +</div> + +<nav id="bd-toc-nav"> + <ul class="visible nav section-nav flex-column"> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#attributes"> + Attributes + </a> + </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#classes"> + Classes + </a> + </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#module-contents"> + Module Contents + </a> + <ul class="visible nav section-nav flex-column"> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.Accumulator"> + <code class="docutils literal notranslate"> + <span class="pre"> + Accumulator + </span> + </code> + </a> + <ul class="nav section-nav flex-column"> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.Accumulator.evaluate"> + <code class="docutils literal notranslate"> + <span class="pre"> + Accumulator.evaluate() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.Accumulator.merge"> + <code class="docutils literal notranslate"> + <span class="pre"> + Accumulator.merge() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.Accumulator.state"> + <code class="docutils literal notranslate"> + <span class="pre"> + Accumulator.state() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.Accumulator.update"> + <code class="docutils literal notranslate"> + <span class="pre"> + Accumulator.update() + </span> + </code> + </a> + </li> + </ul> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.AggregateUDF"> + <code class="docutils literal notranslate"> + <span class="pre"> + AggregateUDF + </span> + </code> + </a> + <ul class="nav section-nav flex-column"> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.AggregateUDF.__call__"> + <code class="docutils literal notranslate"> + <span class="pre"> + AggregateUDF.__call__() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.AggregateUDF.udaf"> + <code class="docutils literal notranslate"> + <span class="pre"> + AggregateUDF.udaf() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.AggregateUDF._udaf"> + <code class="docutils literal notranslate"> + <span class="pre"> + AggregateUDF._udaf + </span> + </code> + </a> + </li> + </ul> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.ScalarUDF"> + <code class="docutils literal notranslate"> + <span class="pre"> + ScalarUDF + </span> + </code> + </a> + <ul class="nav section-nav flex-column"> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.ScalarUDF.__call__"> + <code class="docutils literal notranslate"> + <span class="pre"> + ScalarUDF.__call__() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.ScalarUDF.udf"> + <code class="docutils literal notranslate"> + <span class="pre"> + ScalarUDF.udf() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.ScalarUDF._udf"> + <code class="docutils literal notranslate"> + <span class="pre"> + ScalarUDF._udf + </span> + </code> + </a> + </li> + </ul> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.TableFunction"> + <code class="docutils literal notranslate"> + <span class="pre"> + TableFunction + </span> + </code> + </a> + <ul class="nav section-nav flex-column"> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.TableFunction.__call__"> + <code class="docutils literal notranslate"> + <span class="pre"> + TableFunction.__call__() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.TableFunction.__repr__"> + <code class="docutils literal notranslate"> + <span class="pre"> + TableFunction.__repr__() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.TableFunction._create_table_udf"> + <code class="docutils literal notranslate"> + <span class="pre"> + TableFunction._create_table_udf() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.TableFunction._create_table_udf_decorator"> + <code class="docutils literal notranslate"> + <span class="pre"> + TableFunction._create_table_udf_decorator() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.TableFunction.udtf"> + <code class="docutils literal notranslate"> + <span class="pre"> + TableFunction.udtf() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.TableFunction._udtf"> + <code class="docutils literal notranslate"> + <span class="pre"> + TableFunction._udtf + </span> + </code> + </a> + </li> + </ul> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.Volatility"> + <code class="docutils literal notranslate"> + <span class="pre"> + Volatility + </span> + </code> + </a> + <ul class="nav section-nav flex-column"> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.Volatility.__str__"> + <code class="docutils literal notranslate"> + <span class="pre"> + Volatility.__str__() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.Volatility.Immutable"> + <code class="docutils literal notranslate"> + <span class="pre"> + Volatility.Immutable + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.Volatility.Stable"> + <code class="docutils literal notranslate"> + <span class="pre"> + Volatility.Stable + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.Volatility.Volatile"> + <code class="docutils literal notranslate"> + <span class="pre"> + Volatility.Volatile + </span> + </code> + </a> + </li> + </ul> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.WindowEvaluator"> + <code class="docutils literal notranslate"> + <span class="pre"> + WindowEvaluator + </span> + </code> + </a> + <ul class="nav section-nav flex-column"> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.WindowEvaluator.evaluate"> + <code class="docutils literal notranslate"> + <span class="pre"> + WindowEvaluator.evaluate() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.WindowEvaluator.evaluate_all"> + <code class="docutils literal notranslate"> + <span class="pre"> + WindowEvaluator.evaluate_all() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.WindowEvaluator.evaluate_all_with_rank"> + <code class="docutils literal notranslate"> + <span class="pre"> + WindowEvaluator.evaluate_all_with_rank() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.WindowEvaluator.get_range"> + <code class="docutils literal notranslate"> + <span class="pre"> + WindowEvaluator.get_range() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.WindowEvaluator.include_rank"> + <code class="docutils literal notranslate"> + <span class="pre"> + WindowEvaluator.include_rank() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.WindowEvaluator.is_causal"> + <code class="docutils literal notranslate"> + <span class="pre"> + WindowEvaluator.is_causal() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.WindowEvaluator.memoize"> + <code class="docutils literal notranslate"> + <span class="pre"> + WindowEvaluator.memoize() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.WindowEvaluator.supports_bounded_execution"> + <code class="docutils literal notranslate"> + <span class="pre"> + WindowEvaluator.supports_bounded_execution() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.WindowEvaluator.uses_window_frame"> + <code class="docutils literal notranslate"> + <span class="pre"> + WindowEvaluator.uses_window_frame() + </span> + </code> + </a> + </li> + </ul> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.WindowUDF"> + <code class="docutils literal notranslate"> + <span class="pre"> + WindowUDF + </span> + </code> + </a> + <ul class="nav section-nav flex-column"> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.WindowUDF.__call__"> + <code class="docutils literal notranslate"> + <span class="pre"> + WindowUDF.__call__() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.WindowUDF._create_window_udf"> + <code class="docutils literal notranslate"> + <span class="pre"> + WindowUDF._create_window_udf() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.WindowUDF._create_window_udf_decorator"> + <code class="docutils literal notranslate"> + <span class="pre"> + WindowUDF._create_window_udf_decorator() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.WindowUDF._get_default_name"> + <code class="docutils literal notranslate"> + <span class="pre"> + WindowUDF._get_default_name() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.WindowUDF._normalize_input_types"> + <code class="docutils literal notranslate"> + <span class="pre"> + WindowUDF._normalize_input_types() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.WindowUDF.udwf"> + <code class="docutils literal notranslate"> + <span class="pre"> + WindowUDF.udwf() + </span> + </code> + </a> + </li> + <li class="toc-h4 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.WindowUDF._udwf"> + <code class="docutils literal notranslate"> + <span class="pre"> + WindowUDF._udwf + </span> + </code> + </a> + </li> + </ul> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined._R"> + <code class="docutils literal notranslate"> + <span class="pre"> + _R + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.udaf"> + <code class="docutils literal notranslate"> + <span class="pre"> + udaf + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.udf"> + <code class="docutils literal notranslate"> + <span class="pre"> + udf + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.udtf"> + <code class="docutils literal notranslate"> + <span class="pre"> + udtf + </span> + </code> + </a> + </li> + <li class="toc-h3 nav-item toc-entry"> + <a class="reference internal nav-link" href="#datafusion.user_defined.udwf"> + <code class="docutils literal notranslate"> + <span class="pre"> + udwf + </span> + </code> + </a> + </li> + </ul> + </li> +</ul> + +</nav> + </div> + + <div class="toc-item"> + + </div> + + + </div> + + + + + + + <main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main"> + + <div> + + <section id="module-datafusion.user_defined"> +<span id="datafusion-user-defined"></span><h1>datafusion.user_defined<a class="headerlink" href="#module-datafusion.user_defined" title="Link to this heading">¶</a></h1> +<p>Provides the user-defined functions for evaluation of dataframes.</p> +<section id="attributes"> +<h2>Attributes<a class="headerlink" href="#attributes" title="Link to this heading">¶</a></h2> +<table class="autosummary longtable table autosummary"> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.user_defined._R" title="datafusion.user_defined._R"><code class="xref py py-obj docutils literal notranslate"><span class="pre">_R</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.user_defined.udaf" title="datafusion.user_defined.udaf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">udaf</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.user_defined.udf" title="datafusion.user_defined.udf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">udf</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.user_defined.udtf" title="datafusion.user_defined.udtf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">udtf</span></code></a></p></td> +<td><p></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.user_defined.udwf" title="datafusion.user_defined.udwf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">udwf</span></code></a></p></td> +<td><p></p></td> +</tr> +</tbody> +</table> +</section> +<section id="classes"> +<h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶</a></h2> +<table class="autosummary longtable table autosummary"> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.user_defined.Accumulator" title="datafusion.user_defined.Accumulator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Accumulator</span></code></a></p></td> +<td><p>Defines how an <a class="reference internal" href="#datafusion.user_defined.AggregateUDF" title="datafusion.user_defined.AggregateUDF"><code class="xref py py-class docutils literal notranslate"><span class="pre">AggregateUDF</span></code></a> accumulates values.</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.user_defined.AggregateUDF" title="datafusion.user_defined.AggregateUDF"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AggregateUDF</span></code></a></p></td> +<td><p>Class for performing scalar user-defined functions (UDF).</p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.user_defined.ScalarUDF" title="datafusion.user_defined.ScalarUDF"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ScalarUDF</span></code></a></p></td> +<td><p>Class for performing scalar user-defined functions (UDF).</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.user_defined.TableFunction" title="datafusion.user_defined.TableFunction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TableFunction</span></code></a></p></td> +<td><p>Class for performing user-defined table functions (UDTF).</p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Volatility</span></code></a></p></td> +<td><p>Defines how stable or volatile a function is.</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.user_defined.WindowEvaluator" title="datafusion.user_defined.WindowEvaluator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">WindowEvaluator</span></code></a></p></td> +<td><p>Evaluator class for user-defined window functions (UDWF).</p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.user_defined.WindowUDF" title="datafusion.user_defined.WindowUDF"><code class="xref py py-obj docutils literal notranslate"><span class="pre">WindowUDF</span></code></a></p></td> +<td><p>Class for performing window user-defined functions (UDF).</p></td> +</tr> +</tbody> +</table> +</section> +<section id="module-contents"> +<h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to this heading">¶</a></h2> +<dl class="py class"> +<dt class="sig sig-object py" id="datafusion.user_defined.Accumulator"> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.user_defined.</span></span><span class="sig-name descname"><span class="pre">Accumulator</span></span><a class="headerlink" href="#datafusion.user_defined.Accumulator" title="Link to this definition">¶</a></dt> +<dd><p>Defines how an <a class="reference internal" href="#datafusion.user_defined.AggregateUDF" title="datafusion.user_defined.AggregateUDF"><code class="xref py py-class docutils literal notranslate"><span class="pre">AggregateUDF</span></code></a> accumulates values.</p> +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.Accumulator.evaluate"> +<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">evaluate</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pyarrow.Scalar</span></span></span><a class="headerlink" href="#datafusion.user_defined.Accumulator.evaluate" title="Link to this definition">¶</a></dt> +<dd><p>Return the resultant value.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.Accumulator.merge"> +<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">states</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.Array</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.user_defined.Accumulator.merge" title="Link to this definition">¶</a></dt> +<dd><p>Merge a set of states.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.Accumulator.state"> +<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">state</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.Scalar</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.user_defined.Accumulator.state" title="Link to this definition">¶</a></dt> +<dd><p>Return the current state.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.Accumulator.update"> +<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.Array</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.user_defined.Accumulator.update" title="Link to this definition">¶</a></dt> +<dd><p>Evaluate an array of values and update state.</p> +</dd></dl> + +</dd></dl> + +<dl class="py class"> +<dt class="sig sig-object py" id="datafusion.user_defined.AggregateUDF"> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.user_defined.</span></span><span class="sig-name descname"><span class="pre">AggregateUDF</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">accumulator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.user_defined.Accumulator" title="datafusion.user_defined.Accumulator"><span class="pre">Accumulator</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.user_defined.AggregateUDF" title="Link to this definition">¶</a></dt> +<dd><p>Class for performing scalar user-defined functions (UDF).</p> +<p>Aggregate UDFs operate on a group of rows and return a single value. See +also <a class="reference internal" href="#datafusion.user_defined.ScalarUDF" title="datafusion.user_defined.ScalarUDF"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScalarUDF</span></code></a> for operating on a row by row basis.</p> +<p>Instantiate a user-defined aggregate function (UDAF).</p> +<p>See <a class="reference internal" href="#datafusion.user_defined.udaf" title="datafusion.user_defined.udaf"><code class="xref py py-func docutils literal notranslate"><span class="pre">udaf()</span></code></a> for a convenience function and argument +descriptions.</p> +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.AggregateUDF.__call__"> +<span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a></span></span><a class="headerlink" href="#datafusion.user_defined.AggregateUDF.__call__" title="Link to this definition">¶</a></dt> +<dd><p>Execute the UDAF.</p> +<p>This function is not typically called by an end user. These calls will +occur during the evaluation of the dataframe.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.AggregateUDF.udaf"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udaf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.user_defined.AggregateUDF" title="datafusion.user_defined.AggregateUDF"><span class="pre">AggregateUDF</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.user_defined.AggregateUDF.udaf" title="Link to this definition">¶</a></dt> +<dt class="sig sig-object py"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udaf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">accum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.user_defined.Accumulator" title="datafusion.user_defined.Accumulator"><span class="pre">Accumulator</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.user_defined.AggregateUDF" title="datafusion.user_defined.AggregateUDF"><span class="pre">AggregateUDF</span></a></span></span></dt> +<dd><p>Create a new User-Defined Aggregate Function (UDAF).</p> +<p>This class allows you to define an aggregate function that can be used in +data aggregation or window function calls.</p> +<dl class="simple"> +<dt>Usage:</dt><dd><ul class="simple"> +<li><p>As a function: <code class="docutils literal notranslate"><span class="pre">udaf(accum,</span> <span class="pre">input_types,</span> <span class="pre">return_type,</span> <span class="pre">state_type,</span> <span class="pre">volatility,</span> <span class="pre">name)</span></code>.</p></li> +<li><p>As a decorator: <code class="docutils literal notranslate"><span class="pre">@udaf(input_types,</span> <span class="pre">return_type,</span> <span class="pre">state_type,</span> <span class="pre">volatility,</span> <span class="pre">name)</span></code>. +When using <code class="docutils literal notranslate"><span class="pre">udaf</span></code> as a decorator, do not pass <code class="docutils literal notranslate"><span class="pre">accum</span></code> explicitly.</p></li> +</ul> +</dd> +</dl> +<p>Function example:</p> +<p>If your <a class="reference internal" href="#datafusion.user_defined.Accumulator" title="datafusion.user_defined.Accumulator"><code class="xref py py-class docutils literal notranslate"><span class="pre">Accumulator</span></code></a> can be instantiated with no arguments, you +can simply pass it’s type as <cite>accum</cite>. If you need to pass additional +arguments to it’s constructor, you can define a lambda or a factory method. +During runtime the <a class="reference internal" href="#datafusion.user_defined.Accumulator" title="datafusion.user_defined.Accumulator"><code class="xref py py-class docutils literal notranslate"><span class="pre">Accumulator</span></code></a> will be constructed for every +instance in which this UDAF is used. The following examples are all valid:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">pyarrow</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">pa</span> +<span class="kn">import</span><span class="w"> </span><span class="nn">pyarrow.compute</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">pc</span> + +<span class="k">class</span><span class="w"> </span><span class="nc">Summarize</span><span class="p">(</span><span class="n">Accumulator</span><span class="p">):</span> + <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bias</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.0</span><span class="p">):</span> + <span class="bp">self</span><span class="o">.</span><span class="n">_sum</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">scalar</span><span class="p">(</span><span class="n">bias</span><span class="p">)</span> + + <span class="k">def</span><span class="w"> </span><span class="nf">state</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">list</span><span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">Scalar</span><span class="p">]:</span> + <span class="k">return</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_sum</span><span class="p">]</span> + + <span class="k">def</span><span class="w"> </span><span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">values</span><span class="p">:</span> <span class="n">pa</span><span class="o">.</span><span class="n">Array</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> + <span class="bp">self</span><span class="o">.</span><span class="n">_sum</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">scalar</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_sum</span><span class="o">.</span><span class="n">as_py</span><span class="p">()</span> <span class="o">+</span> <span class="n">pc</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">values</span><span class="p">)</span><span class="o">.</span><span class="n">as_py</span><span class="p">())</span> + + <span class="k">def</span><span class="w"> </span><span class="nf">merge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">states</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">Array</span><span class="p">])</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> + <span class="bp">self</span><span class="o">.</span><span class="n">_sum</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">scalar</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_sum</span><span class="o">.</span><span class="n">as_py</span><span class="p">()</span> <span class="o">+</span> <span class="n">pc</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">states</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span><span class="o">.</span><span class="n">as_py</span><span class="p">())</span> + + <span class="k">def</span><span class="w"> </span><span class="nf">evaluate</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">pa</span><span class="o">.</span><span class="n">Scalar</span><span class="p">:</span> + <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sum</span> + +<span class="k">def</span><span class="w"> </span><span class="nf">sum_bias_10</span><span class="p">()</span> <span class="o">-></span> <span class="n">Summarize</span><span class="p">:</span> + <span class="k">return</span> <span class="n">Summarize</span><span class="p">(</span><span class="mf">10.0</span><span class="p">)</span> + +<span class="n">udaf1</span> <span class="o">=</span> <span class="n">udaf</span><span class="p">(</span><span class="n">Summarize</span><span class="p">,</span> <span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">(),</span> <span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">(),</span> <span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">()],</span> + <span class="s2">"immutable"</span><span class="p">)</span> +<span class="n">udaf2</span> <span class="o">=</span> <span class="n">udaf</span><span class="p">(</span><span class="n">sum_bias_10</span><span class="p">,</span> <span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">(),</span> <span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">(),</span> <span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">()],</span> + <span class="s2">"immutable"</span><span class="p">)</span> +<span class="n">udaf3</span> <span class="o">=</span> <span class="n">udaf</span><span class="p">(</span><span class="k">lambda</span><span class="p">:</span> <span class="n">Summarize</span><span class="p">(</span><span class="mf">20.0</span><span class="p">),</span> <span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">(),</span> <span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">(),</span> + <span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">()],</span> <span class="s2">"immutable"</span><span class="p">)</span> +</pre></div> +</div> +<p>Decorator example::</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@udaf</span><span class="p">(</span><span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">(),</span> <span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">(),</span> <span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">()],</span> <span class="s2">"immutable"</span><span class="p">)</span> +<span class="k">def</span><span class="w"> </span><span class="nf">udf4</span><span class="p">()</span> <span class="o">-></span> <span class="n">Summarize</span><span class="p">:</span> + <span class="k">return</span> <span class="n">Summarize</span><span class="p">(</span><span class="mf">10.0</span><span class="p">)</span> +</pre></div> +</div> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>accum</strong> – The accumulator python function. Only needed when calling as a +function. Skip this argument when using <code class="docutils literal notranslate"><span class="pre">udaf</span></code> as a decorator.</p></li> +<li><p><strong>input_types</strong> – The data types of the arguments to <code class="docutils literal notranslate"><span class="pre">accum</span></code>.</p></li> +<li><p><strong>return_type</strong> – The data type of the return value.</p></li> +<li><p><strong>state_type</strong> – The data types of the intermediate accumulation.</p></li> +<li><p><strong>volatility</strong> – See <a class="reference internal" href="#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><code class="xref py py-class docutils literal notranslate"><span class="pre">Volatility</span></code></a> for allowed values.</p></li> +<li><p><strong>name</strong> – A descriptive name for the function.</p></li> +</ul> +</dd> +<dt class="field-even">Returns<span class="colon">:</span></dt> +<dd class="field-even"><p>A user-defined aggregate function, which can be used in either data +aggregation or window function calls.</p> +</dd> +</dl> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.user_defined.AggregateUDF._udaf"> +<span class="sig-name descname"><span class="pre">_udaf</span></span><a class="headerlink" href="#datafusion.user_defined.AggregateUDF._udaf" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +</dd></dl> + +<dl class="py class"> +<dt class="sig sig-object py" id="datafusion.user_defined.ScalarUDF"> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.user_defined.</span></span><span class="sig-name descname"><span class="pre">ScalarUDF</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">_R</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">_R</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.user_defined.ScalarUDF" title="Link to this definition">¶</a></dt> +<dd><p>Class for performing scalar user-defined functions (UDF).</p> +<p>Scalar UDFs operate on a row by row basis. See also <a class="reference internal" href="#datafusion.user_defined.AggregateUDF" title="datafusion.user_defined.AggregateUDF"><code class="xref py py-class docutils literal notranslate"><span class="pre">AggregateUDF</span></code></a> for +operating on a group of rows.</p> +<p>Instantiate a scalar user-defined function (UDF).</p> +<p>See helper method <a class="reference internal" href="#datafusion.user_defined.udf" title="datafusion.user_defined.udf"><code class="xref py py-func docutils literal notranslate"><span class="pre">udf()</span></code></a> for argument details.</p> +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.ScalarUDF.__call__"> +<span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a></span></span><a class="headerlink" href="#datafusion.user_defined.ScalarUDF.__call__" title="Link to this definition">¶</a></dt> +<dd><p>Execute the UDF.</p> +<p>This function is not typically called by an end user. These calls will +occur during the evaluation of the dataframe.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.ScalarUDF.udf"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">_R</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.user_defined.ScalarUDF" title="datafusion.user_defined.ScalarUDF"><span class="pre">ScalarUDF</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.user_defined.ScalarUDF.udf" title="Link to this definition">¶</a></dt> +<dt class="sig sig-object py"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">_R</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">_R</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.user_defined.ScalarUDF" title="datafusion.user_defined.ScalarUDF"><span class="pre">ScalarUDF</span></a></span></span></dt> +<dd><p>Create a new User-Defined Function (UDF).</p> +<p>This class can be used both as either a function or a decorator.</p> +<dl class="simple"> +<dt>Usage:</dt><dd><ul class="simple"> +<li><p>As a function: <code class="docutils literal notranslate"><span class="pre">udf(func,</span> <span class="pre">input_types,</span> <span class="pre">return_type,</span> <span class="pre">volatility,</span> <span class="pre">name)</span></code>.</p></li> +<li><p>As a decorator: <code class="docutils literal notranslate"><span class="pre">@udf(input_types,</span> <span class="pre">return_type,</span> <span class="pre">volatility,</span> <span class="pre">name)</span></code>. +When used a decorator, do <strong>not</strong> pass <code class="docutils literal notranslate"><span class="pre">func</span></code> explicitly.</p></li> +</ul> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>func</strong> (<em>Callable</em><em>, </em><em>optional</em>) – Only needed when calling as a function. +Skip this argument when using <code class="docutils literal notranslate"><span class="pre">udf</span></code> as a decorator.</p></li> +<li><p><strong>input_types</strong> (<em>list</em><em>[</em><em>pa.DataType</em><em>]</em>) – The data types of the arguments +to <code class="docutils literal notranslate"><span class="pre">func</span></code>. This list must be of the same length as the number of +arguments.</p></li> +<li><p><strong>return_type</strong> (<em>_R</em>) – The data type of the return value from the function.</p></li> +<li><p><strong>volatility</strong> (<a class="reference internal" href="#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><em>Volatility</em></a><em> | </em><em>str</em>) – See <cite>Volatility</cite> for allowed values.</p></li> +<li><p><strong>name</strong> (<em>Optional</em><em>[</em><em>str</em><em>]</em>) – A descriptive name for the function.</p></li> +</ul> +</dd> +<dt class="field-even">Returns<span class="colon">:</span></dt> +<dd class="field-even"><p>A user-defined function that can be used in SQL expressions, +data aggregation, or window function calls.</p> +</dd> +</dl> +<p>Example: Using <code class="docutils literal notranslate"><span class="pre">udf</span></code> as a function:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">double_func</span><span class="p">(</span><span class="n">x</span><span class="p">):</span> + <span class="k">return</span> <span class="n">x</span> <span class="o">*</span> <span class="mi">2</span> +<span class="n">double_udf</span> <span class="o">=</span> <span class="n">udf</span><span class="p">(</span><span class="n">double_func</span><span class="p">,</span> <span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">int32</span><span class="p">()],</span> <span class="n">pa</span><span class="o">.</span><span class="n">int32</span><span class="p">(),</span> +<span class="s2">"volatile"</span><span class="p">,</span> <span class="s2">"double_it"</span><span class="p">)</span> +</pre></div> +</div> +<p>Example: Using <code class="docutils literal notranslate"><span class="pre">udf</span></code> as a decorator:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@udf</span><span class="p">([</span><span class="n">pa</span><span class="o">.</span><span class="n">int32</span><span class="p">()],</span> <span class="n">pa</span><span class="o">.</span><span class="n">int32</span><span class="p">(),</span> <span class="s2">"volatile"</span><span class="p">,</span> <span class="s2">"double_it"</span><span class="p">)</span> +<span class="k">def</span><span class="w"> </span><span class="nf">double_udf</span><span class="p">(</span><span class="n">x</span><span class="p">):</span> + <span class="k">return</span> <span class="n">x</span> <span class="o">*</span> <span class="mi">2</span> +</pre></div> +</div> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.user_defined.ScalarUDF._udf"> +<span class="sig-name descname"><span class="pre">_udf</span></span><a class="headerlink" href="#datafusion.user_defined.ScalarUDF._udf" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +</dd></dl> + +<dl class="py class"> +<dt class="sig sig-object py" id="datafusion.user_defined.TableFunction"> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.user_defined.</span></span><span class="sig-name descname"><span class="pre">TableFunction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.user_defined.TableFunction" title="Link to this definition">¶</a></dt> +<dd><p>Class for performing user-defined table functions (UDTF).</p> +<p>Table functions generate new table providers based on the +input expressions.</p> +<p>Instantiate a user-defined table function (UDTF).</p> +<p>See <a class="reference internal" href="#datafusion.user_defined.udtf" title="datafusion.user_defined.udtf"><code class="xref py py-func docutils literal notranslate"><span class="pre">udtf()</span></code></a> for a convenience function and argument +descriptions.</p> +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.TableFunction.__call__"> +<span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Any</span></span></span><a class="headerlink" href="#datafusion.user_defined.TableFunction.__call__" title="Link to this definition">¶</a></dt> +<dd><p>Execute the UDTF and return a table provider.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.TableFunction.__repr__"> +<span class="sig-name descname"><span class="pre">__repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.user_defined.TableFunction.__repr__" title="Link to this definition">¶</a></dt> +<dd><p>User printable representation.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.TableFunction._create_table_udf"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_create_table_udf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.user_defined.TableFunction" title="datafusion.user_defined.TableFunction"><span class="pre">TableFunction</span></a></span></span><a class="headerlink" href="#datafusion.user_defined.TableFunction._create_table_udf" title="Link to this definition">¶</a></dt> +<dd><p>Create a TableFunction instance from function arguments.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.TableFunction._create_table_udf_decorator"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_create_table_udf_decorator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.user_defined.WindowEvaluator" title="datafusion.user_defined.WindowEvaluator"><span class="pre">WindowEvaluator</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.user_defined.TableFunction._create_table_udf_decorator" title="Link to this definition">¶</a></dt> +<dd><p>Create a decorator for a WindowUDF.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.TableFunction.udtf"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udtf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.user_defined.TableFunction.udtf" title="Link to this definition">¶</a></dt> +<dt class="sig sig-object py"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udtf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.user_defined.TableFunction" title="datafusion.user_defined.TableFunction"><span class="pre">TableFunction</span></a></span></span></dt> +<dd><p>Create a new User-Defined Table Function (UDTF).</p> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.user_defined.TableFunction._udtf"> +<span class="sig-name descname"><span class="pre">_udtf</span></span><a class="headerlink" href="#datafusion.user_defined.TableFunction._udtf" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +</dd></dl> + +<dl class="py class"> +<dt class="sig sig-object py" id="datafusion.user_defined.Volatility"> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.user_defined.</span></span><span class="sig-name descname"><span class="pre">Volatility</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwds</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.user_defined.Volatility" title="Link to this definition">¶</a></dt> +<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">enum.Enum</span></code></p> +<p>Defines how stable or volatile a function is.</p> +<p>When setting the volatility of a function, you can either pass this +enumeration or a <code class="docutils literal notranslate"><span class="pre">str</span></code>. The <code class="docutils literal notranslate"><span class="pre">str</span></code> equivalent is the lower case value of the +name (<cite>“immutable”</cite>, <cite>“stable”</cite>, or <cite>“volatile”</cite>).</p> +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.Volatility.__str__"> +<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.user_defined.Volatility.__str__" title="Link to this definition">¶</a></dt> +<dd><p>Returns the string equivalent.</p> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.user_defined.Volatility.Immutable"> +<span class="sig-name descname"><span class="pre">Immutable</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#datafusion.user_defined.Volatility.Immutable" title="Link to this definition">¶</a></dt> +<dd><p>An immutable function will always return the same output when given the +same input.</p> +<p>DataFusion will attempt to inline immutable functions during planning.</p> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.user_defined.Volatility.Stable"> +<span class="sig-name descname"><span class="pre">Stable</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#datafusion.user_defined.Volatility.Stable" title="Link to this definition">¶</a></dt> +<dd><p>Returns the same value for a given input within a single queries.</p> +<p>A stable function may return different values given the same input across +different queries but must return the same value for a given input within a +query. An example of this is the <code class="docutils literal notranslate"><span class="pre">Now</span></code> function. DataFusion will attempt to +inline <code class="docutils literal notranslate"><span class="pre">Stable</span></code> functions during planning, when possible. For query +<code class="docutils literal notranslate"><span class="pre">select</span> <span class="pre">col1,</span> <span class="pre">now()</span> <span class="pre">from</span> <span class="pre">t1</span></code>, it might take a while to execute but <code class="docutils literal notranslate"><span class="pre">now()</span></code> +column will be the same for each output row, which is evaluated during +planning.</p> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.user_defined.Volatility.Volatile"> +<span class="sig-name descname"><span class="pre">Volatile</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#datafusion.user_defined.Volatility.Volatile" title="Link to this definition">¶</a></dt> +<dd><p>A volatile function may change the return value from evaluation to +evaluation.</p> +<p>Multiple invocations of a volatile function may return different results +when used in the same query. An example of this is the random() function. +DataFusion can not evaluate such functions during planning. In the query +<code class="docutils literal notranslate"><span class="pre">select</span> <span class="pre">col1,</span> <span class="pre">random()</span> <span class="pre">from</span> <span class="pre">t1</span></code>, <code class="docutils literal notranslate"><span class="pre">random()</span></code> function will be evaluated +for each output row, resulting in a unique random value for each row.</p> +</dd></dl> + +</dd></dl> + +<dl class="py class"> +<dt class="sig sig-object py" id="datafusion.user_defined.WindowEvaluator"> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.user_defined.</span></span><span class="sig-name descname"><span class="pre">WindowEvaluator</span></span><a class="headerlink" href="#datafusion.user_defined.WindowEvaluator" title="Link to this definition">¶</a></dt> +<dd><p>Evaluator class for user-defined window functions (UDWF).</p> +<p>It is up to the user to decide which evaluate function is appropriate.</p> +<table class="table"> +<thead> +<tr class="row-odd"><th class="head"><p><code class="docutils literal notranslate"><span class="pre">uses_window_frame</span></code></p></th> +<th class="head"><p><code class="docutils literal notranslate"><span class="pre">supports_bounded_execution</span></code></p></th> +<th class="head"><p><code class="docutils literal notranslate"><span class="pre">include_rank</span></code></p></th> +<th class="head"><p>function_to_implement</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>False (default)</p></td> +<td><p>False (default)</p></td> +<td><p>False (default)</p></td> +<td><p><code class="docutils literal notranslate"><span class="pre">evaluate_all</span></code></p></td> +</tr> +<tr class="row-odd"><td><p>False</p></td> +<td><p>True</p></td> +<td><p>False</p></td> +<td><p><code class="docutils literal notranslate"><span class="pre">evaluate</span></code></p></td> +</tr> +<tr class="row-even"><td><p>False</p></td> +<td><p>True/False</p></td> +<td><p>True</p></td> +<td><p><code class="docutils literal notranslate"><span class="pre">evaluate_all_with_rank</span></code></p></td> +</tr> +<tr class="row-odd"><td><p>True</p></td> +<td><p>True/False</p></td> +<td><p>True/False</p></td> +<td><p><code class="docutils literal notranslate"><span class="pre">evaluate</span></code></p></td> +</tr> +</tbody> +</table> +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.WindowEvaluator.evaluate"> +<span class="sig-name descname"><span class="pre">evaluate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.Array</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eval_range</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pyarrow.Scalar</span></span></span><a class="headerlink" href="#datafusion.user_defined.WindowEvaluator.evaluate" title="Link to this definition">¶</a></dt> +<dd><p>Evaluate window function on a range of rows in an input partition.</p> +<p>This is the simplest and most general function to implement +but also the least performant as it creates output one row at +a time. It is typically much faster to implement stateful +evaluation using one of the other specialized methods on this +trait.</p> +<p>Returns a [<cite>ScalarValue</cite>] that is the value of the window +function within <cite>range</cite> for the entire partition. Argument +<cite>values</cite> contains the evaluation result of function arguments +and evaluation results of ORDER BY expressions. If function has a +single argument, <cite>values[1..]</cite> will contain ORDER BY expression results.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.WindowEvaluator.evaluate_all"> +<span class="sig-name descname"><span class="pre">evaluate_all</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.Array</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_rows</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pyarrow.Array</span></span></span><a class="headerlink" href="#datafusion.user_defined.WindowEvaluator.evaluate_all" title="Link to this definition">¶</a></dt> +<dd><p>Evaluate a window function on an entire input partition.</p> +<p>This function is called once per input <em>partition</em> for window functions that +<em>do not use</em> values from the window frame, such as +<a class="reference internal" href="../functions/index.html#datafusion.functions.row_number" title="datafusion.functions.row_number"><code class="xref py py-func docutils literal notranslate"><span class="pre">row_number()</span></code></a>, +<a class="reference internal" href="../functions/index.html#datafusion.functions.rank" title="datafusion.functions.rank"><code class="xref py py-func docutils literal notranslate"><span class="pre">rank()</span></code></a>, +<a class="reference internal" href="../functions/index.html#datafusion.functions.dense_rank" title="datafusion.functions.dense_rank"><code class="xref py py-func docutils literal notranslate"><span class="pre">dense_rank()</span></code></a>, +<a class="reference internal" href="../functions/index.html#datafusion.functions.percent_rank" title="datafusion.functions.percent_rank"><code class="xref py py-func docutils literal notranslate"><span class="pre">percent_rank()</span></code></a>, +<a class="reference internal" href="../functions/index.html#datafusion.functions.cume_dist" title="datafusion.functions.cume_dist"><code class="xref py py-func docutils literal notranslate"><span class="pre">cume_dist()</span></code></a>, +<a class="reference internal" href="../functions/index.html#datafusion.functions.lead" title="datafusion.functions.lead"><code class="xref py py-func docutils literal notranslate"><span class="pre">lead()</span></code></a>, +and <a class="reference internal" href="../functions/index.html#datafusion.functions.lag" title="datafusion.functions.lag"><code class="xref py py-func docutils literal notranslate"><span class="pre">lag()</span></code></a>.</p> +<p>It produces the result of all rows in a single pass. It +expects to receive the entire partition as the <code class="docutils literal notranslate"><span class="pre">value</span></code> and +must produce an output column with one output row for every +input row.</p> +<p><code class="docutils literal notranslate"><span class="pre">num_rows</span></code> is required to correctly compute the output in case +<code class="docutils literal notranslate"><span class="pre">len(values)</span> <span class="pre">==</span> <span class="pre">0</span></code></p> +<p>Implementing this function is an optimization. Certain window +functions are not affected by the window frame definition or +the query doesn’t have a frame, and <code class="docutils literal notranslate"><span class="pre">evaluate</span></code> skips the +(costly) window frame boundary calculation and the overhead of +calling <code class="docutils literal notranslate"><span class="pre">evaluate</span></code> for each output row.</p> +<p>For example, the <cite>LAG</cite> built in window function does not use +the values of its window frame (it can be computed in one shot +on the entire partition with <code class="docutils literal notranslate"><span class="pre">Self::evaluate_all</span></code> regardless of the +window defined in the <code class="docutils literal notranslate"><span class="pre">OVER</span></code> clause)</p> +<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>lag(x, 1) OVER (ORDER BY z ROWS BETWEEN 2 PRECEDING AND 3 FOLLOWING) +</pre></div> +</div> +<p>However, <code class="docutils literal notranslate"><span class="pre">avg()</span></code> computes the average in the window and thus +does use its window frame.</p> +<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>avg(x) OVER (PARTITION BY y ORDER BY z ROWS BETWEEN 2 PRECEDING AND 3 FOLLOWING) +</pre></div> +</div> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.WindowEvaluator.evaluate_all_with_rank"> +<span class="sig-name descname"><span class="pre">evaluate_all_with_rank</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_rows</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ranks_in_partition</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pyarrow.Array</span></span></span><a class="headerlink" href="#datafusion.user_defined.WindowEvaluator.evaluate_all_with_rank" title="Link to this definition">¶</a></dt> +<dd><p>Called for window functions that only need the rank of a row.</p> +<p>Evaluate the partition evaluator against the partition using +the row ranks. For example, <code class="docutils literal notranslate"><span class="pre">rank(col("a"))</span></code> produces</p> +<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>a | rank +- + ---- +A | 1 +A | 1 +C | 3 +D | 4 +D | 4 +</pre></div> +</div> +<p>For this case, <cite>num_rows</cite> would be <cite>5</cite> and the +<cite>ranks_in_partition</cite> would be called with</p> +<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>[ + (0,1), + (2,2), + (3,4), +] +</pre></div> +</div> +<p>The user must implement this method if <code class="docutils literal notranslate"><span class="pre">include_rank</span></code> returns True.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.WindowEvaluator.get_range"> +<span class="sig-name descname"><span class="pre">get_range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">idx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_rows</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.user_defined.WindowEvaluator.get_range" title="Link to this definition">¶</a></dt> +<dd><p>Return the range for the window fuction.</p> +<p>If <cite>uses_window_frame</cite> flag is <cite>false</cite>. This method is used to +calculate required range for the window function during +stateful execution.</p> +<p>Generally there is no required range, hence by default this +returns smallest range(current row). e.g seeing current row is +enough to calculate window result (such as row_number, rank, +etc)</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>idx:</strong> – Current index:</p></li> +<li><p><strong>num_rows</strong> – Number of rows.</p></li> +</ul> +</dd> +</dl> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.WindowEvaluator.include_rank"> +<span class="sig-name descname"><span class="pre">include_rank</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datafusion.user_defined.WindowEvaluator.include_rank" title="Link to this definition">¶</a></dt> +<dd><p>Can this function be evaluated with (only) rank?</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.WindowEvaluator.is_causal"> +<span class="sig-name descname"><span class="pre">is_causal</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datafusion.user_defined.WindowEvaluator.is_causal" title="Link to this definition">¶</a></dt> +<dd><p>Get whether evaluator needs future data for its result.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.WindowEvaluator.memoize"> +<span class="sig-name descname"><span class="pre">memoize</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.user_defined.WindowEvaluator.memoize" title="Link to this definition">¶</a></dt> +<dd><p>Perform a memoize operation to improve performance.</p> +<p>When the window frame has a fixed beginning (e.g UNBOUNDED +PRECEDING), some functions such as FIRST_VALUE and +NTH_VALUE do not need the (unbounded) input once they have +seen a certain amount of input.</p> +<p><cite>memoize</cite> is called after each input batch is processed, and +such functions can save whatever they need</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.WindowEvaluator.supports_bounded_execution"> +<span class="sig-name descname"><span class="pre">supports_bounded_execution</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datafusion.user_defined.WindowEvaluator.supports_bounded_execution" title="Link to this definition">¶</a></dt> +<dd><p>Can the window function be incrementally computed using bounded memory?</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.WindowEvaluator.uses_window_frame"> +<span class="sig-name descname"><span class="pre">uses_window_frame</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datafusion.user_defined.WindowEvaluator.uses_window_frame" title="Link to this definition">¶</a></dt> +<dd><p>Does the window function use the values from the window frame?</p> +</dd></dl> + +</dd></dl> + +<dl class="py class"> +<dt class="sig sig-object py" id="datafusion.user_defined.WindowUDF"> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.user_defined.</span></span><span class="sig-name descname"><span class="pre">WindowUDF</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.user_defined.WindowEvaluator" title="datafusion.user_defined.WindowEvaluator"><span class="pre">WindowEvaluator</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.user_defined.WindowUDF" title="Link to this definition">¶</a></dt> +<dd><p>Class for performing window user-defined functions (UDF).</p> +<p>Window UDFs operate on a partition of rows. See +also <a class="reference internal" href="#datafusion.user_defined.ScalarUDF" title="datafusion.user_defined.ScalarUDF"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScalarUDF</span></code></a> for operating on a row by row basis.</p> +<p>Instantiate a user-defined window function (UDWF).</p> +<p>See <a class="reference internal" href="#datafusion.user_defined.udwf" title="datafusion.user_defined.udwf"><code class="xref py py-func docutils literal notranslate"><span class="pre">udwf()</span></code></a> for a convenience function and argument +descriptions.</p> +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.WindowUDF.__call__"> +<span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a></span></span><a class="headerlink" href="#datafusion.user_defined.WindowUDF.__call__" title="Link to this definition">¶</a></dt> +<dd><p>Execute the UDWF.</p> +<p>This function is not typically called by an end user. These calls will +occur during the evaluation of the dataframe.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.WindowUDF._create_window_udf"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_create_window_udf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.user_defined.WindowEvaluator" title="datafusion.user_defined.WindowEvaluator"><span class="pre">WindowEvaluator</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.user_defined.WindowUDF" title="datafusion.user_defined.WindowUDF"><span class="pre">WindowUDF</span></a></span></span><a class="headerlink" href="#datafusion.user_defined.WindowUDF._create_window_udf" title="Link to this definition">¶</a></dt> +<dd><p>Create a WindowUDF instance from function arguments.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.WindowUDF._create_window_udf_decorator"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_create_window_udf_decorator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.user_defined.WindowEvaluator" title="datafusion.user_defined.WindowEvaluator"><span class="pre">WindowEvaluator</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="../expr/index.html#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">datafusion.expr.Expr</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.user_defined.WindowUDF._create_window_udf_decorator" title="Link to this definition">¶</a></dt> +<dd><p>Create a decorator for a WindowUDF.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.WindowUDF._get_default_name"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_get_default_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.user_defined.WindowUDF._get_default_name" title="Link to this definition">¶</a></dt> +<dd><p>Get the default name for a function based on its attributes.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.WindowUDF._normalize_input_types"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_normalize_input_types</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.user_defined.WindowUDF._normalize_input_types" title="Link to this definition">¶</a></dt> +<dd><p>Convert a single DataType to a list if needed.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datafusion.user_defined.WindowUDF.udwf"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udwf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">Ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.user_defined.WindowUDF" title="datafusion.user_defined.WindowUDF"><span class="pre">WindowUDF</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.user_defined.WindowUDF.udwf" title="Link to this definition">¶</a></dt> +<dt class="sig sig-object py"> +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udwf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.user_defined.WindowEvaluator" title="datafusion.user_defined.WindowEvaluator"><span class="pre">WindowEvaluator</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_types</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volatility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><span class="pre">Volatility</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.user_defined.WindowUDF" title="datafusion.user_defined.WindowUDF"><span class="pre">WindowUDF</span></a></span></span></dt> +<dd><p>Create a new User-Defined Window Function (UDWF).</p> +<p>This class can be used both as either a function or a decorator.</p> +<dl class="simple"> +<dt>Usage:</dt><dd><ul class="simple"> +<li><p>As a function: <code class="docutils literal notranslate"><span class="pre">udwf(func,</span> <span class="pre">input_types,</span> <span class="pre">return_type,</span> <span class="pre">volatility,</span> <span class="pre">name)</span></code>.</p></li> +<li><p>As a decorator: <code class="docutils literal notranslate"><span class="pre">@udwf(input_types,</span> <span class="pre">return_type,</span> <span class="pre">volatility,</span> <span class="pre">name)</span></code>. +When using <code class="docutils literal notranslate"><span class="pre">udwf</span></code> as a decorator, do not pass <code class="docutils literal notranslate"><span class="pre">func</span></code> explicitly.</p></li> +</ul> +</dd> +</dl> +<p>Function example:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">pyarrow</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">pa</span> + +<span class="k">class</span><span class="w"> </span><span class="nc">BiasedNumbers</span><span class="p">(</span><span class="n">WindowEvaluator</span><span class="p">):</span> + <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">start</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> + <span class="bp">self</span><span class="o">.</span><span class="n">start</span> <span class="o">=</span> <span class="n">start</span> + + <span class="k">def</span><span class="w"> </span><span class="nf">evaluate_all</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">values</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">Array</span><span class="p">],</span> + <span class="n">num_rows</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-></span> <span class="n">pa</span><span class="o">.</span><span class="n">Array</span><span class="p">:</span> + <span class="k">return</span> <span class="n">pa</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="bp">self</span><span class="o">.</span><span class="n">start</span> <span class="o">+</span> <span class="n">i</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">num_rows</span><span class="p">)])</span> + +<span class="k">def</span><span class="w"> </span><span class="nf">bias_10</span><span class="p">()</span> <span class="o">-></span> <span class="n">BiasedNumbers</span><span class="p">:</span> + <span class="k">return</span> <span class="n">BiasedNumbers</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span> + +<span class="n">udwf1</span> <span class="o">=</span> <span class="n">udwf</span><span class="p">(</span><span class="n">BiasedNumbers</span><span class="p">,</span> <span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span> <span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span> <span class="s2">"immutable"</span><span class="p">)</span> +<span class="n">udwf2</span> <span class="o">=</span> <span class="n">udwf</span><span class="p">(</span><span class="n">bias_10</span><span class="p">,</span> <span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span> <span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span> <span class="s2">"immutable"</span><span class="p">)</span> +<span class="n">udwf3</span> <span class="o">=</span> <span class="n">udwf</span><span class="p">(</span><span class="k">lambda</span><span class="p">:</span> <span class="n">BiasedNumbers</span><span class="p">(</span><span class="mi">20</span><span class="p">),</span> <span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span> <span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span> <span class="s2">"immutable"</span><span class="p">)</span> +</pre></div> +</div> +<p>Decorator example:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@udwf</span><span class="p">(</span><span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span> <span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span> <span class="s2">"immutable"</span><span class="p">)</span> +<span class="k">def</span><span class="w"> </span><span class="nf">biased_numbers</span><span class="p">()</span> <span class="o">-></span> <span class="n">BiasedNumbers</span><span class="p">:</span> + <span class="k">return</span> <span class="n">BiasedNumbers</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span> +</pre></div> +</div> +<dl class="field-list simple"> +<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>func</strong> – Only needed when calling as a function. Skip this argument when +using <code class="docutils literal notranslate"><span class="pre">udwf</span></code> as a decorator.</p></li> +<li><p><strong>input_types</strong> – The data types of the arguments.</p></li> +<li><p><strong>return_type</strong> – The data type of the return value.</p></li> +<li><p><strong>volatility</strong> – See <a class="reference internal" href="#datafusion.user_defined.Volatility" title="datafusion.user_defined.Volatility"><code class="xref py py-class docutils literal notranslate"><span class="pre">Volatility</span></code></a> for allowed values.</p></li> +<li><p><strong>name</strong> – A descriptive name for the function.</p></li> +</ul> +</dd> +<dt class="field-even">Returns<span class="colon">:</span></dt> +<dd class="field-even"><p>A user-defined window function that can be used in window function calls.</p> +</dd> +</dl> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="datafusion.user_defined.WindowUDF._udwf"> +<span class="sig-name descname"><span class="pre">_udwf</span></span><a class="headerlink" href="#datafusion.user_defined.WindowUDF._udwf" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +</dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.user_defined._R"> +<span class="sig-prename descclassname"><span class="pre">datafusion.user_defined.</span></span><span class="sig-name descname"><span class="pre">_R</span></span><a class="headerlink" href="#datafusion.user_defined._R" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.user_defined.udaf"> +<span class="sig-prename descclassname"><span class="pre">datafusion.user_defined.</span></span><span class="sig-name descname"><span class="pre">udaf</span></span><a class="headerlink" href="#datafusion.user_defined.udaf" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.user_defined.udf"> +<span class="sig-prename descclassname"><span class="pre">datafusion.user_defined.</span></span><span class="sig-name descname"><span class="pre">udf</span></span><a class="headerlink" href="#datafusion.user_defined.udf" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.user_defined.udtf"> +<span class="sig-prename descclassname"><span class="pre">datafusion.user_defined.</span></span><span class="sig-name descname"><span class="pre">udtf</span></span><a class="headerlink" href="#datafusion.user_defined.udtf" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="datafusion.user_defined.udwf"> +<span class="sig-prename descclassname"><span class="pre">datafusion.user_defined.</span></span><span class="sig-name descname"><span class="pre">udwf</span></span><a class="headerlink" href="#datafusion.user_defined.udwf" title="Link to this definition">¶</a></dt> +<dd></dd></dl> + +</section> +</section> + + + </div> + + + <!-- Previous / next buttons --> +<div class='prev-next-area'> + <a class='left-prev' id="prev-link" href="../unparser/index.html" title="previous page"> + <i class="fas fa-angle-left"></i> + <div class="prev-next-info"> + <p class="prev-next-subtitle">previous</p> + <p class="prev-next-title">datafusion.unparser</p> + </div> + </a> +</div> + + </main> + + + </div> + </div> + + <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> + +<!-- Based on pydata_sphinx_theme/footer.html --> +<footer class="footer mt-5 mt-md-0"> + <div class="container"> + + <div class="footer-item"> + <p class="copyright"> + © Copyright 2019-2024, Apache Software Foundation.<br> +</p> + </div> + + <div class="footer-item"> + <p class="sphinx-version"> +Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.1.3.<br> +</p> + </div> + + <div class="footer-item"> + <p>Apache Arrow DataFusion, Arrow DataFusion, Apache, the Apache feather logo, and the Apache Arrow DataFusion project logo</p> + <p>are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.</p> + </div> + </div> +</footer> + + + </body> +</html> \ No newline at end of file
diff --git a/autoapi/index.html b/autoapi/index.html index 40c2c4c..b8d920e 100644 --- a/autoapi/index.html +++ b/autoapi/index.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../user-guide/common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul> @@ -398,10 +423,12 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="datafusion/index.html">datafusion</a><ul> <li class="toctree-l2"><a class="reference internal" href="datafusion/catalog/index.html">datafusion.catalog</a></li> +<li class="toctree-l2"><a class="reference internal" href="datafusion/col/index.html">datafusion.col</a></li> <li class="toctree-l2"><a class="reference internal" href="datafusion/context/index.html">datafusion.context</a></li> <li class="toctree-l2"><a class="reference internal" href="datafusion/dataframe/index.html">datafusion.dataframe</a></li> <li class="toctree-l2"><a class="reference internal" href="datafusion/expr/index.html">datafusion.expr</a></li> <li class="toctree-l2"><a class="reference internal" href="datafusion/functions/index.html">datafusion.functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="datafusion/html_formatter/index.html">datafusion.html_formatter</a></li> <li class="toctree-l2"><a class="reference internal" href="datafusion/input/index.html">datafusion.input</a><ul> <li class="toctree-l3"><a class="reference internal" href="datafusion/input/base/index.html">datafusion.input.base</a></li> <li class="toctree-l3"><a class="reference internal" href="datafusion/input/location/index.html">datafusion.input.location</a></li> @@ -413,6 +440,8 @@ <li class="toctree-l2"><a class="reference internal" href="datafusion/record_batch/index.html">datafusion.record_batch</a></li> <li class="toctree-l2"><a class="reference internal" href="datafusion/substrait/index.html">datafusion.substrait</a></li> <li class="toctree-l2"><a class="reference internal" href="datafusion/udf/index.html">datafusion.udf</a></li> +<li class="toctree-l2"><a class="reference internal" href="datafusion/unparser/index.html">datafusion.unparser</a></li> +<li class="toctree-l2"><a class="reference internal" href="datafusion/user_defined/index.html">datafusion.user_defined</a></li> </ul> </li> </ul>
diff --git a/contributor-guide/ffi.html b/contributor-guide/ffi.html index 7abc766..2607e72 100644 --- a/contributor-guide/ffi.html +++ b/contributor-guide/ffi.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../user-guide/common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/contributor-guide/introduction.html b/contributor-guide/introduction.html index 6a97a45..a8c329b 100644 --- a/contributor-guide/introduction.html +++ b/contributor-guide/introduction.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../user-guide/common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/genindex.html b/genindex.html index 6d65db2..3044426 100644 --- a/genindex.html +++ b/genindex.html
@@ -114,6 +114,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="user-guide/common-operations/index.html"> Common Operations @@ -273,6 +278,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -292,6 +302,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="autoapi/datafusion/input/index.html"> datafusion.input @@ -344,6 +359,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul> @@ -442,13 +467,19 @@ <li><a href="autoapi/datafusion/index.html#datafusion.AggregateUDF.__call__">__call__() (datafusion.AggregateUDF method)</a> <ul> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.CellFormatter.__call__">(datafusion.html_formatter.CellFormatter method)</a> +</li> <li><a href="autoapi/datafusion/index.html#datafusion.ScalarUDF.__call__">(datafusion.ScalarUDF method)</a> </li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.AggregateUDF.__call__">(datafusion.udf.AggregateUDF method)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.TableFunction.__call__">(datafusion.TableFunction method)</a> </li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.ScalarUDF.__call__">(datafusion.udf.ScalarUDF method)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.AggregateUDF.__call__">(datafusion.user_defined.AggregateUDF method)</a> </li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.WindowUDF.__call__">(datafusion.udf.WindowUDF method)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.ScalarUDF.__call__">(datafusion.user_defined.ScalarUDF method)</a> +</li> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.TableFunction.__call__">(datafusion.user_defined.TableFunction method)</a> +</li> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.WindowUDF.__call__">(datafusion.user_defined.WindowUDF method)</a> </li> <li><a href="autoapi/datafusion/index.html#datafusion.WindowUDF.__call__">(datafusion.WindowUDF method)</a> </li> @@ -564,9 +595,11 @@ </li> <li><a href="autoapi/datafusion/plan/index.html#datafusion.plan.LogicalPlan.__repr__">(datafusion.plan.LogicalPlan method)</a> </li> + <li><a href="autoapi/datafusion/index.html#datafusion.TableFunction.__repr__">(datafusion.TableFunction method)</a> +</li> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.TableFunction.__repr__">(datafusion.user_defined.TableFunction method)</a> +</li> </ul></li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> <li><a href="autoapi/datafusion/index.html#datafusion.Expr.__richcmp__">__richcmp__() (datafusion.Expr method)</a> <ul> @@ -579,6 +612,8 @@ <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.__rmod__">(datafusion.expr.Expr attribute)</a> </li> </ul></li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> <li><a href="autoapi/datafusion/index.html#datafusion.Expr.__rmul__">__rmul__ (datafusion.Expr attribute)</a> <ul> @@ -603,7 +638,7 @@ <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.__rtruediv__">(datafusion.expr.Expr attribute)</a> </li> </ul></li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.Volatility.__str__">__str__() (datafusion.udf.Volatility method)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.Volatility.__str__">__str__() (datafusion.user_defined.Volatility method)</a> </li> <li><a href="autoapi/datafusion/index.html#datafusion.Expr.__sub__">__sub__() (datafusion.Expr method)</a> @@ -617,25 +652,65 @@ <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.__truediv__">(datafusion.expr.Expr method)</a> </li> </ul></li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.WindowUDF._create_window_udf">_create_window_udf() (datafusion.udf.WindowUDF static method)</a> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter._build_expandable_cell">_build_expandable_cell() (datafusion.html_formatter.DataFrameHtmlFormatter method)</a> +</li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter._build_html_footer">_build_html_footer() (datafusion.html_formatter.DataFrameHtmlFormatter method)</a> +</li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter._build_html_header">_build_html_header() (datafusion.html_formatter.DataFrameHtmlFormatter method)</a> +</li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter._build_regular_cell">_build_regular_cell() (datafusion.html_formatter.DataFrameHtmlFormatter method)</a> +</li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter._build_table_body">_build_table_body() (datafusion.html_formatter.DataFrameHtmlFormatter method)</a> +</li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter._build_table_container_start">_build_table_container_start() (datafusion.html_formatter.DataFrameHtmlFormatter method)</a> +</li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter._build_table_header">_build_table_header() (datafusion.html_formatter.DataFrameHtmlFormatter method)</a> +</li> + <li><a href="autoapi/datafusion/index.html#datafusion.TableFunction._create_table_udf">_create_table_udf() (datafusion.TableFunction static method)</a> + + <ul> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.TableFunction._create_table_udf">(datafusion.user_defined.TableFunction static method)</a> +</li> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.TableFunction._create_table_udf_decorator">_create_table_udf_decorator() (datafusion.TableFunction static method)</a> + + <ul> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.TableFunction._create_table_udf_decorator">(datafusion.user_defined.TableFunction static method)</a> +</li> + </ul></li> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.WindowUDF._create_window_udf">_create_window_udf() (datafusion.user_defined.WindowUDF static method)</a> <ul> <li><a href="autoapi/datafusion/index.html#datafusion.WindowUDF._create_window_udf">(datafusion.WindowUDF static method)</a> </li> </ul></li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.WindowUDF._create_window_udf_decorator">_create_window_udf_decorator() (datafusion.udf.WindowUDF static method)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.WindowUDF._create_window_udf_decorator">_create_window_udf_decorator() (datafusion.user_defined.WindowUDF static method)</a> <ul> <li><a href="autoapi/datafusion/index.html#datafusion.WindowUDF._create_window_udf_decorator">(datafusion.WindowUDF static method)</a> </li> </ul></li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.WindowUDF._get_default_name">_get_default_name() (datafusion.udf.WindowUDF static method)</a> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter._custom_cell_builder">_custom_cell_builder (datafusion.html_formatter.DataFrameHtmlFormatter attribute)</a> +</li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter._custom_header_builder">_custom_header_builder (datafusion.html_formatter.DataFrameHtmlFormatter attribute)</a> +</li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.FormatterManager._default_formatter">_default_formatter (datafusion.html_formatter.FormatterManager attribute)</a> +</li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter._format_cell_value">_format_cell_value() (datafusion.html_formatter.DataFrameHtmlFormatter method)</a> +</li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter._get_cell_value">_get_cell_value() (datafusion.html_formatter.DataFrameHtmlFormatter method)</a> +</li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter._get_default_css">_get_default_css() (datafusion.html_formatter.DataFrameHtmlFormatter method)</a> +</li> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.WindowUDF._get_default_name">_get_default_name() (datafusion.user_defined.WindowUDF static method)</a> <ul> <li><a href="autoapi/datafusion/index.html#datafusion.WindowUDF._get_default_name">(datafusion.WindowUDF static method)</a> </li> </ul></li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.WindowUDF._normalize_input_types">_normalize_input_types() (datafusion.udf.WindowUDF static method)</a> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter._get_javascript">_get_javascript() (datafusion.html_formatter.DataFrameHtmlFormatter method)</a> +</li> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.WindowUDF._normalize_input_types">_normalize_input_types() (datafusion.user_defined.WindowUDF static method)</a> <ul> <li><a href="autoapi/datafusion/index.html#datafusion.WindowUDF._normalize_input_types">(datafusion.WindowUDF static method)</a> @@ -647,7 +722,7 @@ </li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Window._partition_by">_partition_by (datafusion.expr.Window attribute)</a> </li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf._R">_R (in module datafusion.udf)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined._R">_R (in module datafusion.user_defined)</a> </li> <li><a href="autoapi/datafusion/index.html#datafusion.ExecutionPlan._raw_plan">_raw_plan (datafusion.ExecutionPlan attribute)</a> @@ -659,32 +734,48 @@ <li><a href="autoapi/datafusion/plan/index.html#datafusion.plan.LogicalPlan._raw_plan">(datafusion.plan.LogicalPlan attribute)</a> </li> </ul></li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter._refresh_formatter_reference">_refresh_formatter_reference() (in module datafusion.html_formatter)</a> +</li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame._repr_html_">_repr_html_() (datafusion.dataframe.DataFrame method)</a> </li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter._styles_loaded">_styles_loaded (datafusion.html_formatter.DataFrameHtmlFormatter attribute)</a> +</li> <li><a href="autoapi/datafusion/index.html#datafusion.Expr._to_pyarrow_types">_to_pyarrow_types (datafusion.Expr attribute)</a> <ul> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr._to_pyarrow_types">(datafusion.expr.Expr attribute)</a> </li> </ul></li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter._type_formatters">_type_formatters (datafusion.html_formatter.DataFrameHtmlFormatter attribute)</a> +</li> <li><a href="autoapi/datafusion/index.html#datafusion.AggregateUDF._udaf">_udaf (datafusion.AggregateUDF attribute)</a> <ul> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.AggregateUDF._udaf">(datafusion.udf.AggregateUDF attribute)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.AggregateUDF._udaf">(datafusion.user_defined.AggregateUDF attribute)</a> </li> </ul></li> <li><a href="autoapi/datafusion/index.html#datafusion.ScalarUDF._udf">_udf (datafusion.ScalarUDF attribute)</a> <ul> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.ScalarUDF._udf">(datafusion.udf.ScalarUDF attribute)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.ScalarUDF._udf">(datafusion.user_defined.ScalarUDF attribute)</a> </li> </ul></li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.WindowUDF._udwf">_udwf (datafusion.udf.WindowUDF attribute)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.TableFunction._udtf">_udtf (datafusion.TableFunction attribute)</a> + + <ul> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.TableFunction._udtf">(datafusion.user_defined.TableFunction attribute)</a> +</li> + </ul></li> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.WindowUDF._udwf">_udwf (datafusion.user_defined.WindowUDF attribute)</a> <ul> <li><a href="autoapi/datafusion/index.html#datafusion.WindowUDF._udwf">(datafusion.WindowUDF attribute)</a> </li> </ul></li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter._validate_bool">_validate_bool() (in module datafusion.html_formatter)</a> +</li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter._validate_positive_int">_validate_positive_int() (in module datafusion.html_formatter)</a> +</li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Window._window_frame">_window_frame (datafusion.expr.Window attribute)</a> </li> </ul></td> @@ -693,18 +784,36 @@ <h2 id="A">A</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.abs">abs() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.abs">abs() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.abs">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.abs">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/index.html#datafusion.Accumulator">Accumulator (class in datafusion)</a> <ul> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.Accumulator">(class in datafusion.udf)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.Accumulator">(class in datafusion.user_defined)</a> </li> </ul></li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.acos">acos() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.acos">acos() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.acos">(datafusion.expr.Expr method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.acosh">acosh() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.acos">(in module datafusion.functions)</a> </li> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.acosh">acosh() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.acosh">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.acosh">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Aggregate">Aggregate (in module datafusion.expr)</a> </li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.aggregate">aggregate() (datafusion.dataframe.DataFrame method)</a> @@ -714,7 +823,7 @@ <li><a href="autoapi/datafusion/index.html#datafusion.AggregateUDF">AggregateUDF (class in datafusion)</a> <ul> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.AggregateUDF">(class in datafusion.udf)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.AggregateUDF">(class in datafusion.user_defined)</a> </li> </ul></li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Alias">Alias (in module datafusion.expr)</a> @@ -749,14 +858,32 @@ </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_concat">array_concat() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_dims">array_dims() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.array_dims">array_dims() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.array_dims">(datafusion.expr.Expr method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_distinct">array_distinct() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_dims">(in module datafusion.functions)</a> </li> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.array_distinct">array_distinct() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.array_distinct">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_distinct">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_element">array_element() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_empty">array_empty() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.array_empty">array_empty() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.array_empty">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_empty">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_except">array_except() (in module datafusion.functions)</a> </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_extract">array_extract() (in module datafusion.functions)</a> @@ -769,20 +896,44 @@ </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_indexof">array_indexof() (in module datafusion.functions)</a> </li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_intersect">array_intersect() (in module datafusion.functions)</a> </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_join">array_join() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_length">array_length() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.array_length">array_length() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.array_length">(datafusion.expr.Expr method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_ndims">array_ndims() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_length">(in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_pop_back">array_pop_back() (in module datafusion.functions)</a> + </ul></li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.array_ndims">array_ndims() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.array_ndims">(datafusion.expr.Expr method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_pop_front">array_pop_front() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_ndims">(in module datafusion.functions)</a> </li> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.array_pop_back">array_pop_back() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.array_pop_back">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_pop_back">(in module datafusion.functions)</a> +</li> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.array_pop_front">array_pop_front() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.array_pop_front">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_pop_front">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_position">array_position() (in module datafusion.functions)</a> </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.array_positions">array_positions() (in module datafusion.functions)</a> @@ -819,26 +970,62 @@ </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.arrow_cast">arrow_cast() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.arrow_typeof">arrow_typeof() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.arrow_typeof">arrow_typeof() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.arrow_typeof">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.arrow_typeof">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.ArrowArrayExportable">ArrowArrayExportable (class in datafusion.context)</a> </li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.ArrowStreamExportable">ArrowStreamExportable (class in datafusion.context)</a> </li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.SortExpr.ascending">ascending() (datafusion.expr.SortExpr method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.ascii">ascii() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.ascii">ascii() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.ascii">(datafusion.expr.Expr method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.asin">asin() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.ascii">(in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.asinh">asinh() (in module datafusion.functions)</a> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.asin">asin() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.asin">(datafusion.expr.Expr method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.atan">atan() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.asin">(in module datafusion.functions)</a> </li> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.asinh">asinh() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.asinh">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.asinh">(in module datafusion.functions)</a> +</li> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.atan">atan() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.atan">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.atan">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.atan2">atan2() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.atanh">atanh() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.atanh">atanh() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.atanh">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.atanh">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.avg">avg() (in module datafusion.functions)</a> </li> </ul></td> @@ -861,8 +1048,14 @@ </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.bit_and">bit_and() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.bit_length">bit_length() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.bit_length">bit_length() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.bit_length">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.bit_length">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.bit_or">bit_or() (in module datafusion.functions)</a> </li> </ul></td> @@ -875,8 +1068,14 @@ </li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.Compression.BROTLI">BROTLI (datafusion.dataframe.Compression attribute)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.btrim">btrim() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.btrim">btrim() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.btrim">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.btrim">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/input/base/index.html#datafusion.input.base.BaseInputSource.build_table">build_table() (datafusion.input.base.BaseInputSource method)</a> <ul> @@ -899,8 +1098,14 @@ <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.canonical_name">(datafusion.expr.Expr method)</a> </li> </ul></li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.cardinality">cardinality() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.cardinality">cardinality() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.cardinality">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.cardinality">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Case">Case (in module datafusion.expr)</a> </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.case">case() (in module datafusion.functions)</a> @@ -933,34 +1138,74 @@ </ul></li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.catalog">catalog() (datafusion.context.SessionContext method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.cbrt">cbrt() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.cbrt">cbrt() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.cbrt">(datafusion.expr.Expr method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.ceil">ceil() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.cbrt">(in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.char_length">char_length() (in module datafusion.functions)</a> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.ceil">ceil() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.ceil">(datafusion.expr.Expr method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.character_length">character_length() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.ceil">(in module datafusion.functions)</a> </li> + </ul></li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.CellFormatter">CellFormatter (class in datafusion.html_formatter)</a> +</li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.char_length">char_length() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.char_length">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.char_length">(in module datafusion.functions)</a> +</li> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.character_length">character_length() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.character_length">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.character_length">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/index.html#datafusion.ExecutionPlan.children">children() (datafusion.ExecutionPlan method)</a> <ul> <li><a href="autoapi/datafusion/plan/index.html#datafusion.plan.ExecutionPlan.children">(datafusion.plan.ExecutionPlan method)</a> </li> </ul></li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.chr">chr() (in module datafusion.functions)</a> -</li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.coalesce">coalesce() (in module datafusion.functions)</a> -</li> - <li><a href="autoapi/datafusion/index.html#datafusion.col">col() (in module datafusion)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.chr">chr() (datafusion.Expr method)</a> <ul> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.col">(in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.chr">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.chr">(in module datafusion.functions)</a> </li> </ul></li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.coalesce">coalesce() (in module datafusion.functions)</a> +</li> + <li><a href="autoapi/datafusion/index.html#datafusion.col">col (in module datafusion)</a> + + <ul> + <li><a href="autoapi/datafusion/col/index.html#datafusion.col.col">(in module datafusion.col)</a> +</li> + </ul></li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.col">col() (in module datafusion.functions)</a> +</li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.collect">collect() (datafusion.dataframe.DataFrame method)</a> </li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.collect_partitioned">collect_partitioned() (datafusion.dataframe.DataFrame method)</a> </li> + <li><a href="autoapi/datafusion/index.html#datafusion.column">column (in module datafusion)</a> + + <ul> + <li><a href="autoapi/datafusion/col/index.html#datafusion.col.column">(in module datafusion.col)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Column">Column (in module datafusion.expr)</a> </li> </ul></td> @@ -970,8 +1215,6 @@ <ul> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.column">(datafusion.expr.Expr static method)</a> </li> - <li><a href="autoapi/datafusion/index.html#datafusion.column">(in module datafusion)</a> -</li> </ul></li> <li><a href="autoapi/datafusion/index.html#datafusion.Expr.column_name">column_name() (datafusion.Expr method)</a> @@ -995,16 +1238,42 @@ <li><a href="autoapi/datafusion/index.html#datafusion.SessionConfig.config_internal">(datafusion.SessionConfig attribute)</a> </li> </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.configure_formatter">configure_formatter() (in module datafusion)</a> + + <ul> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.configure_formatter">(in module datafusion.html_formatter)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/substrait/index.html#datafusion.substrait.Consumer">Consumer (class in datafusion.substrait)</a> </li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.CopyTo">CopyTo (in module datafusion.expr)</a> +</li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.corr">corr() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.cos">cos() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.cos">cos() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.cos">(datafusion.expr.Expr method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.cosh">cosh() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.cos">(in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.cot">cot() (in module datafusion.functions)</a> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.cosh">cosh() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.cosh">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.cosh">(in module datafusion.functions)</a> +</li> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.cot">cot() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.cot">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.cot">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.count">count() (datafusion.dataframe.DataFrame method)</a> <ul> @@ -1023,6 +1292,18 @@ </li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.create_dataframe_from_logical_plan">create_dataframe_from_logical_plan() (datafusion.context.SessionContext method)</a> </li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.CreateCatalog">CreateCatalog (in module datafusion.expr)</a> +</li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.CreateCatalogSchema">CreateCatalogSchema (in module datafusion.expr)</a> +</li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.CreateExternalTable">CreateExternalTable (in module datafusion.expr)</a> +</li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.CreateFunction">CreateFunction (in module datafusion.expr)</a> +</li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.CreateFunctionBody">CreateFunctionBody (in module datafusion.expr)</a> +</li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.CreateIndex">CreateIndex (in module datafusion.expr)</a> +</li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.CreateMemoryTable">CreateMemoryTable (in module datafusion.expr)</a> </li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.CreateView">CreateView (in module datafusion.expr)</a> @@ -1035,6 +1316,8 @@ </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.current_time">current_time() (in module datafusion.functions)</a> </li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter.custom_css">custom_css (datafusion.html_formatter.DataFrameHtmlFormatter attribute)</a> +</li> </ul></td> </tr></table> @@ -1055,6 +1338,8 @@ </ul></li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame">DataFrame (class in datafusion.dataframe)</a> </li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter">DataFrameHtmlFormatter (class in datafusion.html_formatter)</a> +</li> <li> datafusion @@ -1070,6 +1355,13 @@ </li> </ul></li> <li> + datafusion.col + + <ul> + <li><a href="autoapi/datafusion/col/index.html#module-datafusion.col">module</a> +</li> + </ul></li> + <li> datafusion.context <ul> @@ -1098,6 +1390,13 @@ </li> </ul></li> <li> + datafusion.html_formatter + + <ul> + <li><a href="autoapi/datafusion/html_formatter/index.html#module-datafusion.html_formatter">module</a> +</li> + </ul></li> + <li> datafusion.input <ul> @@ -1160,14 +1459,28 @@ <li><a href="autoapi/datafusion/udf/index.html#module-datafusion.udf">module</a> </li> </ul></li> + <li> + datafusion.unparser + + <ul> + <li><a href="autoapi/datafusion/unparser/index.html#module-datafusion.unparser">module</a> +</li> + </ul></li> + <li> + datafusion.user_defined + + <ul> + <li><a href="autoapi/datafusion/user_defined/index.html#module-datafusion.user_defined">module</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.date_bin">date_bin() (in module datafusion.functions)</a> </li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.date_part">date_part() (in module datafusion.functions)</a> </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.date_trunc">date_trunc() (in module datafusion.functions)</a> </li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.datepart">datepart() (in module datafusion.functions)</a> </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.datetrunc">datetrunc() (in module datafusion.functions)</a> @@ -1178,16 +1491,30 @@ <li><a href="autoapi/datafusion/index.html#datafusion.Database.db">(datafusion.Database attribute)</a> </li> </ul></li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Deallocate">Deallocate (in module datafusion.expr)</a> +</li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.decode">decode() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.degrees">degrees() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/unparser/index.html#datafusion.unparser.Dialect.default">default() (datafusion.unparser.Dialect static method)</a> </li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DefaultStyleProvider">DefaultStyleProvider (class in datafusion.html_formatter)</a> +</li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.degrees">degrees() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.degrees">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.degrees">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.dense_rank">dense_rank() (in module datafusion.functions)</a> </li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.deregister_table">deregister_table() (datafusion.context.SessionContext method)</a> </li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.describe">describe() (datafusion.dataframe.DataFrame method)</a> </li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.DescribeTable">DescribeTable (in module datafusion.expr)</a> +</li> <li><a href="autoapi/datafusion/substrait/index.html#datafusion.substrait.Serde.deserialize">deserialize() (datafusion.substrait.Serde static method)</a> </li> <li><a href="autoapi/datafusion/substrait/index.html#datafusion.substrait.Serde.deserialize_bytes">deserialize_bytes() (datafusion.substrait.Serde static method)</a> @@ -1196,6 +1523,10 @@ </li> <li><a href="autoapi/datafusion/index.html#datafusion.DFSchema">DFSchema (in module datafusion)</a> </li> + <li><a href="autoapi/datafusion/unparser/index.html#datafusion.unparser.Dialect">Dialect (class in datafusion.unparser)</a> +</li> + <li><a href="autoapi/datafusion/unparser/index.html#datafusion.unparser.Dialect.dialect">dialect (datafusion.unparser.Dialect attribute)</a> +</li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.digest">digest() (in module datafusion.functions)</a> </li> <li><a href="autoapi/datafusion/index.html#datafusion.ExecutionPlan.display">display() (datafusion.ExecutionPlan method)</a> @@ -1246,22 +1577,40 @@ <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.distinct">(datafusion.expr.Expr method)</a> </li> </ul></li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.DmlStatement">DmlStatement (in module datafusion.expr)</a> +</li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.drop">drop() (datafusion.dataframe.DataFrame method)</a> </li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.DropCatalogSchema">DropCatalogSchema (in module datafusion.expr)</a> +</li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.DropFunction">DropFunction (in module datafusion.expr)</a> +</li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.DropTable">DropTable (in module datafusion.expr)</a> </li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.DropView">DropView (in module datafusion.expr)</a> +</li> + <li><a href="autoapi/datafusion/unparser/index.html#datafusion.unparser.Dialect.duckdb">duckdb() (datafusion.unparser.Dialect static method)</a> +</li> </ul></td> </tr></table> <h2 id="E">E</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.empty">empty() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.empty">empty() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.empty">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.empty">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.empty_table">empty_table() (datafusion.context.SessionContext method)</a> </li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.EmptyRelation">EmptyRelation (in module datafusion.expr)</a> </li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter.enable_cell_expansion">enable_cell_expansion (datafusion.html_formatter.DataFrameHtmlFormatter attribute)</a> +</li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.enable_url_table">enable_url_table() (datafusion.context.SessionContext method)</a> </li> <li><a href="autoapi/datafusion/substrait/index.html#datafusion.substrait.Plan.encode">encode() (datafusion.substrait.Plan method)</a> @@ -1277,21 +1626,23 @@ <li><a href="autoapi/datafusion/index.html#datafusion.Accumulator.evaluate">evaluate() (datafusion.Accumulator method)</a> <ul> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.Accumulator.evaluate">(datafusion.udf.Accumulator method)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.Accumulator.evaluate">(datafusion.user_defined.Accumulator method)</a> </li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.WindowEvaluator.evaluate">(datafusion.udf.WindowEvaluator method)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.WindowEvaluator.evaluate">(datafusion.user_defined.WindowEvaluator method)</a> </li> </ul></li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.WindowEvaluator.evaluate_all">evaluate_all() (datafusion.udf.WindowEvaluator method)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.WindowEvaluator.evaluate_all">evaluate_all() (datafusion.user_defined.WindowEvaluator method)</a> </li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.WindowEvaluator.evaluate_all_with_rank">evaluate_all_with_rank() (datafusion.udf.WindowEvaluator method)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.WindowEvaluator.evaluate_all_with_rank">evaluate_all_with_rank() (datafusion.user_defined.WindowEvaluator method)</a> </li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.except_all">except_all() (datafusion.dataframe.DataFrame method)</a> </li> - <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.execute">execute() (datafusion.context.SessionContext method)</a> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Execute">Execute (in module datafusion.expr)</a> </li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.execute">execute() (datafusion.context.SessionContext method)</a> +</li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.execute_stream">execute_stream() (datafusion.dataframe.DataFrame method)</a> </li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.execute_stream_partitioned">execute_stream_partitioned() (datafusion.dataframe.DataFrame method)</a> @@ -1306,8 +1657,14 @@ </ul></li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Exists">Exists (in module datafusion.expr)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.exp">exp() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.exp">exp() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.exp">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.exp">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Explain">Explain (in module datafusion.expr)</a> </li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.explain">explain() (datafusion.dataframe.DataFrame method)</a> @@ -1336,7 +1693,15 @@ <h2 id="F">F</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.factorial">factorial() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.factorial">factorial() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.factorial">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.factorial">(in module datafusion.functions)</a> +</li> + </ul></li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.FileType">FileType (in module datafusion.expr)</a> </li> <li><a href="autoapi/datafusion/index.html#datafusion.Expr.fill_nan">fill_nan() (datafusion.Expr method)</a> @@ -1344,9 +1709,11 @@ <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.fill_nan">(datafusion.expr.Expr method)</a> </li> </ul></li> - <li><a href="autoapi/datafusion/index.html#datafusion.Expr.fill_null">fill_null() (datafusion.Expr method)</a> + <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.fill_null">fill_null() (datafusion.dataframe.DataFrame method)</a> <ul> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.fill_null">(datafusion.Expr method)</a> +</li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.fill_null">(datafusion.expr.Expr method)</a> </li> </ul></li> @@ -1364,12 +1731,28 @@ </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.first_value">first_value() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.flatten">flatten() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.flatten">flatten() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.flatten">(datafusion.expr.Expr method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.floor">floor() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.flatten">(in module datafusion.functions)</a> </li> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.floor">floor() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.floor">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.floor">(in module datafusion.functions)</a> +</li> + </ul></li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter.format_html">format_html() (datafusion.html_formatter.DataFrameHtmlFormatter method)</a> +</li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.FormatterManager">FormatterManager (class in datafusion.html_formatter)</a> +</li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.WindowFrameBound.frame_bound">frame_bound (datafusion.expr.WindowFrameBound attribute)</a> </li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.from_arrow">from_arrow() (datafusion.context.SessionContext method)</a> @@ -1398,8 +1781,14 @@ </li> <li><a href="autoapi/datafusion/substrait/index.html#datafusion.substrait.Consumer.from_substrait_plan">from_substrait_plan() (datafusion.substrait.Consumer static method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.from_unixtime">from_unixtime() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.from_unixtime">from_unixtime() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.from_unixtime">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.from_unixtime">(in module datafusion.functions)</a> +</li> + </ul></li> </ul></td> </tr></table> @@ -1408,14 +1797,34 @@ <td style="width: 33%; vertical-align: top;"><ul> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.gcd">gcd() (in module datafusion.functions)</a> </li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DefaultStyleProvider.get_cell_style">get_cell_style() (datafusion.html_formatter.DefaultStyleProvider method)</a> + + <ul> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.StyleProvider.get_cell_style">(datafusion.html_formatter.StyleProvider method)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.Compression.get_default_level">get_default_level() (datafusion.dataframe.Compression method)</a> </li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.FormatterManager.get_formatter">get_formatter() (datafusion.html_formatter.FormatterManager class method)</a> + + <ul> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.get_formatter">(in module datafusion.html_formatter)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.WindowFrame.get_frame_units">get_frame_units() (datafusion.expr.WindowFrame method)</a> <ul> <li><a href="autoapi/datafusion/index.html#datafusion.WindowFrame.get_frame_units">(datafusion.WindowFrame method)</a> </li> </ul></li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DefaultStyleProvider.get_header_style">get_header_style() (datafusion.html_formatter.DefaultStyleProvider method)</a> + + <ul> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.StyleProvider.get_header_style">(datafusion.html_formatter.StyleProvider method)</a> +</li> + </ul></li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.WindowFrame.get_lower_bound">get_lower_bound() (datafusion.expr.WindowFrame method)</a> <ul> @@ -1424,9 +1833,7 @@ </ul></li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.WindowFrameBound.get_offset">get_offset() (datafusion.expr.WindowFrameBound method)</a> </li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.WindowEvaluator.get_range">get_range() (datafusion.udf.WindowEvaluator method)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.WindowEvaluator.get_range">get_range() (datafusion.user_defined.WindowEvaluator method)</a> </li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.WindowFrame.get_upper_bound">get_upper_bound() (datafusion.expr.WindowFrame method)</a> @@ -1462,14 +1869,20 @@ <td style="width: 33%; vertical-align: top;"><ul> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.ILike">ILike (in module datafusion.expr)</a> </li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.Volatility.Immutable">Immutable (datafusion.udf.Volatility attribute)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.Volatility.Immutable">Immutable (datafusion.user_defined.Volatility attribute)</a> </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.in_list">in_list() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.WindowEvaluator.include_rank">include_rank() (datafusion.udf.WindowEvaluator method)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.WindowEvaluator.include_rank">include_rank() (datafusion.user_defined.WindowEvaluator method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.initcap">initcap() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.initcap">initcap() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.initcap">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.initcap">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.InList">InList (in module datafusion.expr)</a> </li> <li><a href="autoapi/datafusion/index.html#datafusion.LogicalPlan.inputs">inputs() (datafusion.LogicalPlan method)</a> @@ -1484,7 +1897,7 @@ </li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.into_view">into_view() (datafusion.dataframe.DataFrame method)</a> </li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.WindowEvaluator.is_causal">is_causal() (datafusion.udf.WindowEvaluator method)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.WindowEvaluator.is_causal">is_causal() (datafusion.user_defined.WindowEvaluator method)</a> </li> <li><a href="autoapi/datafusion/input/base/index.html#datafusion.input.base.BaseInputSource.is_correct_input">is_correct_input() (datafusion.input.base.BaseInputSource method)</a> @@ -1496,8 +1909,6 @@ </ul></li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.WindowFrameBound.is_current_row">is_current_row() (datafusion.expr.WindowFrameBound method)</a> </li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.WindowFrameBound.is_following">is_following() (datafusion.expr.WindowFrameBound method)</a> </li> <li><a href="autoapi/datafusion/index.html#datafusion.Expr.is_not_null">is_not_null() (datafusion.Expr method)</a> @@ -1506,6 +1917,8 @@ <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.is_not_null">(datafusion.expr.Expr method)</a> </li> </ul></li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> <li><a href="autoapi/datafusion/index.html#datafusion.Expr.is_null">is_null() (datafusion.Expr method)</a> <ul> @@ -1514,12 +1927,20 @@ </ul></li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.WindowFrameBound.is_preceding">is_preceding() (datafusion.expr.WindowFrameBound method)</a> </li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter.is_styles_loaded">is_styles_loaded() (datafusion.html_formatter.DataFrameHtmlFormatter class method)</a> +</li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.WindowFrameBound.is_unbounded">is_unbounded() (datafusion.expr.WindowFrameBound method)</a> </li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.IsFalse">IsFalse (in module datafusion.expr)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.isnan">isnan() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.isnan">isnan() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.isnan">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.isnan">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.IsNotFalse">IsNotFalse (in module datafusion.expr)</a> </li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.IsNotNull">IsNotNull (in module datafusion.expr)</a> @@ -1534,8 +1955,14 @@ </li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.IsUnknown">IsUnknown (in module datafusion.expr)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.iszero">iszero() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.iszero">iszero() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.iszero">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.iszero">(in module datafusion.functions)</a> +</li> + </ul></li> </ul></td> </tr></table> @@ -1582,8 +2009,14 @@ </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.left">left() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.length">length() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.length">length() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.length">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.length">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.levenshtein">levenshtein() (in module datafusion.functions)</a> </li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Like">Like (in module datafusion.expr)</a> @@ -1598,10 +2031,22 @@ </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.list_concat">list_concat() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.list_dims">list_dims() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.list_dims">list_dims() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.list_dims">(datafusion.expr.Expr method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.list_distinct">list_distinct() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.list_dims">(in module datafusion.functions)</a> </li> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.list_distinct">list_distinct() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.list_distinct">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.list_distinct">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.list_element">list_element() (in module datafusion.functions)</a> </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.list_except">list_except() (in module datafusion.functions)</a> @@ -1614,10 +2059,22 @@ </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.list_join">list_join() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.list_length">list_length() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.list_length">list_length() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.list_length">(datafusion.expr.Expr method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.list_ndims">list_ndims() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.list_length">(in module datafusion.functions)</a> </li> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.list_ndims">list_ndims() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.list_ndims">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.list_ndims">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.list_position">list_position() (in module datafusion.functions)</a> </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.list_positions">list_positions() (in module datafusion.functions)</a> @@ -1666,8 +2123,14 @@ <li><a href="autoapi/datafusion/index.html#datafusion.literal">(in module datafusion)</a> </li> </ul></li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.ln">ln() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.ln">ln() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.ln">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.ln">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/object_store/index.html#datafusion.object_store.LocalFileSystem">LocalFileSystem (in module datafusion.object_store)</a> </li> <li><a href="autoapi/datafusion/input/index.html#datafusion.input.LocationInputPlugin">LocationInputPlugin (class in datafusion.input)</a> @@ -1678,10 +2141,22 @@ </ul></li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.log">log() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.log10">log10() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.log10">log10() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.log10">(datafusion.expr.Expr method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.log2">log2() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.log10">(in module datafusion.functions)</a> </li> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.log2">log2() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.log2">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.log2">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.logical_plan">logical_plan() (datafusion.dataframe.DataFrame method)</a> </li> <li><a href="autoapi/datafusion/index.html#datafusion.LogicalPlan">LogicalPlan (class in datafusion)</a> @@ -1690,12 +2165,24 @@ <li><a href="autoapi/datafusion/plan/index.html#datafusion.plan.LogicalPlan">(class in datafusion.plan)</a> </li> </ul></li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.lower">lower() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.lower">lower() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.lower">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.lower">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.lpad">lpad() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.ltrim">ltrim() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.ltrim">ltrim() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.ltrim">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.ltrim">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.Compression.LZ4">LZ4 (datafusion.dataframe.Compression attribute)</a> </li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.Compression.LZ4_RAW">LZ4_RAW (datafusion.dataframe.Compression attribute)</a> @@ -1714,24 +2201,40 @@ </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.max">max() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.md5">md5() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter.max_cell_length">max_cell_length (datafusion.html_formatter.DataFrameHtmlFormatter attribute)</a> </li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter.max_height">max_height (datafusion.html_formatter.DataFrameHtmlFormatter attribute)</a> +</li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter.max_memory_bytes">max_memory_bytes (datafusion.html_formatter.DataFrameHtmlFormatter attribute)</a> +</li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter.max_width">max_width (datafusion.html_formatter.DataFrameHtmlFormatter attribute)</a> +</li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.md5">md5() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.md5">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.md5">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.mean">mean() (in module datafusion.functions)</a> </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.median">median() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.WindowEvaluator.memoize">memoize() (datafusion.udf.WindowEvaluator method)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.WindowEvaluator.memoize">memoize() (datafusion.user_defined.WindowEvaluator method)</a> </li> <li><a href="autoapi/datafusion/index.html#datafusion.Accumulator.merge">merge() (datafusion.Accumulator method)</a> <ul> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.Accumulator.merge">(datafusion.udf.Accumulator method)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.Accumulator.merge">(datafusion.user_defined.Accumulator method)</a> </li> </ul></li> <li><a href="autoapi/datafusion/object_store/index.html#datafusion.object_store.MicrosoftAzure">MicrosoftAzure (in module datafusion.object_store)</a> </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.min">min() (in module datafusion.functions)</a> </li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter.min_rows_display">min_rows_display (datafusion.html_formatter.DataFrameHtmlFormatter attribute)</a> +</li> <li> module @@ -1740,6 +2243,8 @@ </li> <li><a href="autoapi/datafusion/catalog/index.html#module-datafusion.catalog">datafusion.catalog</a> </li> + <li><a href="autoapi/datafusion/col/index.html#module-datafusion.col">datafusion.col</a> +</li> <li><a href="autoapi/datafusion/context/index.html#module-datafusion.context">datafusion.context</a> </li> <li><a href="autoapi/datafusion/dataframe/index.html#module-datafusion.dataframe">datafusion.dataframe</a> @@ -1748,6 +2253,8 @@ </li> <li><a href="autoapi/datafusion/functions/index.html#module-datafusion.functions">datafusion.functions</a> </li> + <li><a href="autoapi/datafusion/html_formatter/index.html#module-datafusion.html_formatter">datafusion.html_formatter</a> +</li> <li><a href="autoapi/datafusion/input/index.html#module-datafusion.input">datafusion.input</a> </li> <li><a href="autoapi/datafusion/input/base/index.html#module-datafusion.input.base">datafusion.input.base</a> @@ -1766,8 +2273,16 @@ </li> <li><a href="autoapi/datafusion/udf/index.html#module-datafusion.udf">datafusion.udf</a> </li> + <li><a href="autoapi/datafusion/unparser/index.html#module-datafusion.unparser">datafusion.unparser</a> +</li> + <li><a href="autoapi/datafusion/user_defined/index.html#module-datafusion.user_defined">datafusion.user_defined</a> +</li> </ul></li> </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="autoapi/datafusion/unparser/index.html#datafusion.unparser.Dialect.mysql">mysql() (datafusion.unparser.Dialect static method)</a> +</li> + </ul></td> </tr></table> <h2 id="N">N</h2> @@ -1823,7 +2338,15 @@ <h2 id="O">O</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.octet_length">octet_length() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.octet_length">octet_length() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.octet_length">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.octet_length">(in module datafusion.functions)</a> +</li> + </ul></li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.OperateFunctionArg">OperateFunctionArg (in module datafusion.expr)</a> </li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.optimized_logical_plan">optimized_logical_plan() (datafusion.dataframe.DataFrame method)</a> </li> @@ -1833,6 +2356,8 @@ <li><a href="autoapi/datafusion/index.html#datafusion.SQLOptions.options_internal">(datafusion.SQLOptions attribute)</a> </li> </ul></li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> <li><a href="autoapi/datafusion/index.html#datafusion.Expr.order_by">order_by() (datafusion.Expr method)</a> <ul> @@ -1841,8 +2366,6 @@ <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.order_by">(in module datafusion.functions)</a> </li> </ul></li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.CaseBuilder.otherwise">otherwise() (datafusion.expr.CaseBuilder method)</a> </li> <li><a href="autoapi/datafusion/index.html#datafusion.Expr.over">over() (datafusion.Expr method)</a> @@ -1879,16 +2402,22 @@ </li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Placeholder">Placeholder (in module datafusion.expr)</a> </li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> <li><a href="autoapi/datafusion/substrait/index.html#datafusion.substrait.Plan">Plan (class in datafusion.substrait)</a> </li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> <li><a href="autoapi/datafusion/substrait/index.html#datafusion.substrait.Plan.plan_internal">plan_internal (datafusion.substrait.Plan attribute)</a> </li> + <li><a href="autoapi/datafusion/unparser/index.html#datafusion.unparser.Unparser.plan_to_sql">plan_to_sql() (datafusion.unparser.Unparser method)</a> +</li> + <li><a href="autoapi/datafusion/unparser/index.html#datafusion.unparser.Dialect.postgres">postgres() (datafusion.unparser.Dialect static method)</a> +</li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.pow">pow() (in module datafusion.functions)</a> </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.power">power() (in module datafusion.functions)</a> </li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Prepare">Prepare (in module datafusion.expr)</a> +</li> <li><a href="autoapi/datafusion/substrait/index.html#datafusion.substrait.Producer">Producer (class in datafusion.substrait)</a> </li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Projection">Projection (in module datafusion.expr)</a> @@ -1905,8 +2434,14 @@ <h2 id="R">R</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.radians">radians() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.radians">radians() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.radians">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.radians">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.random">random() (in module datafusion.functions)</a> </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.range">range() (in module datafusion.functions)</a> @@ -1973,6 +2508,8 @@ <li><a href="autoapi/datafusion/record_batch/index.html#datafusion.record_batch.RecordBatchStream">(class in datafusion.record_batch)</a> </li> </ul></li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.RecursiveQuery">RecursiveQuery (in module datafusion.expr)</a> +</li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.regexp_count">regexp_count() (in module datafusion.functions)</a> </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.regexp_like">regexp_like() (in module datafusion.functions)</a> @@ -1987,18 +2524,20 @@ </li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.register_dataset">register_dataset() (datafusion.context.SessionContext method)</a> </li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter.register_formatter">register_formatter() (datafusion.html_formatter.DataFrameHtmlFormatter method)</a> +</li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.register_json">register_json() (datafusion.context.SessionContext method)</a> </li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.register_listing_table">register_listing_table() (datafusion.context.SessionContext method)</a> </li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.register_object_store">register_object_store() (datafusion.context.SessionContext method)</a> </li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.register_parquet">register_parquet() (datafusion.context.SessionContext method)</a> </li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.register_record_batches">register_record_batches() (datafusion.context.SessionContext method)</a> </li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.register_table">register_table() (datafusion.context.SessionContext method)</a> </li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.register_table_provider">register_table_provider() (datafusion.context.SessionContext method)</a> @@ -2007,6 +2546,8 @@ </li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.register_udf">register_udf() (datafusion.context.SessionContext method)</a> </li> + <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.register_udtf">register_udtf() (datafusion.context.SessionContext method)</a> +</li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.register_udwf">register_udwf() (datafusion.context.SessionContext method)</a> </li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.register_view">register_view() (datafusion.context.SessionContext method)</a> @@ -2039,8 +2580,20 @@ </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.replace">replace() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.reverse">reverse() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter.repr_rows">repr_rows (datafusion.html_formatter.DataFrameHtmlFormatter attribute)</a> </li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.reset_formatter">reset_formatter() (in module datafusion.html_formatter)</a> +</li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.reset_styles_loaded_state">reset_styles_loaded_state() (in module datafusion.html_formatter)</a> +</li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.reverse">reverse() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.reverse">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.reverse">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/index.html#datafusion.Expr.rex_call_operands">rex_call_operands() (datafusion.Expr method)</a> <ul> @@ -2067,8 +2620,14 @@ </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.rpad">rpad() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.rtrim">rtrim() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.rtrim">rtrim() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.rtrim">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.rtrim">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.RuntimeConfig">RuntimeConfig (class in datafusion.context)</a> </li> <li><a href="autoapi/datafusion/index.html#datafusion.RuntimeEnvBuilder">RuntimeEnvBuilder (class in datafusion)</a> @@ -2088,7 +2647,7 @@ <li><a href="autoapi/datafusion/index.html#datafusion.ScalarUDF">ScalarUDF (class in datafusion)</a> <ul> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.ScalarUDF">(class in datafusion.udf)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.ScalarUDF">(class in datafusion.user_defined)</a> </li> </ul></li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.ScalarVariable">ScalarVariable (in module datafusion.expr)</a> @@ -2135,26 +2694,82 @@ <li><a href="autoapi/datafusion/index.html#datafusion.SessionConfig.set">(datafusion.SessionConfig method)</a> </li> </ul></li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.sha224">sha224() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter.set_custom_cell_builder">set_custom_cell_builder() (datafusion.html_formatter.DataFrameHtmlFormatter method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.sha256">sha256() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter.set_custom_header_builder">set_custom_header_builder() (datafusion.html_formatter.DataFrameHtmlFormatter method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.sha384">sha384() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.FormatterManager.set_formatter">set_formatter() (datafusion.html_formatter.FormatterManager class method)</a> + + <ul> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.set_formatter">(in module datafusion.html_formatter)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.sha512">sha512() (in module datafusion.functions)</a> + </ul></li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.SetVariable">SetVariable (in module datafusion.expr)</a> </li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.sha224">sha224() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.sha224">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.sha224">(in module datafusion.functions)</a> +</li> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.sha256">sha256() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.sha256">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.sha256">(in module datafusion.functions)</a> +</li> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.sha384">sha384() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.sha384">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.sha384">(in module datafusion.functions)</a> +</li> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.sha512">sha512() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.sha512">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.sha512">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.show">show() (datafusion.dataframe.DataFrame method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.signum">signum() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter.show_truncation_message">show_truncation_message (datafusion.html_formatter.DataFrameHtmlFormatter attribute)</a> </li> - <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.SimilarTo">SimilarTo (in module datafusion.expr)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.signum">signum() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.signum">(datafusion.expr.Expr method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.sin">sin() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.signum">(in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.sinh">sinh() (in module datafusion.functions)</a> -</li> + </ul></li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.SimilarTo">SimilarTo (in module datafusion.expr)</a> +</li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.sin">sin() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.sin">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.sin">(in module datafusion.functions)</a> +</li> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.sinh">sinh() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.sinh">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.sinh">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.Compression.SNAPPY">SNAPPY (datafusion.dataframe.Compression attribute)</a> </li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Sort">Sort (in module datafusion.expr)</a> @@ -2175,22 +2790,30 @@ </li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.sql_with_options">sql_with_options() (datafusion.context.SessionContext method)</a> </li> + <li><a href="autoapi/datafusion/unparser/index.html#datafusion.unparser.Dialect.sqlite">sqlite() (datafusion.unparser.Dialect static method)</a> +</li> <li><a href="autoapi/datafusion/index.html#datafusion.SQLOptions">SQLOptions (class in datafusion)</a> <ul> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SQLOptions">(class in datafusion.context)</a> </li> </ul></li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.sqrt">sqrt() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.sqrt">sqrt() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.sqrt">(datafusion.expr.Expr method)</a> </li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.Volatility.Stable">Stable (datafusion.udf.Volatility attribute)</a> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.sqrt">(in module datafusion.functions)</a> +</li> + </ul></li> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.Volatility.Stable">Stable (datafusion.user_defined.Volatility attribute)</a> </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.starts_with">starts_with() (in module datafusion.functions)</a> </li> <li><a href="autoapi/datafusion/index.html#datafusion.Accumulator.state">state() (datafusion.Accumulator method)</a> <ul> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.Accumulator.state">(datafusion.udf.Accumulator method)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.Accumulator.state">(datafusion.user_defined.Accumulator method)</a> </li> </ul></li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.stddev">stddev() (in module datafusion.functions)</a> @@ -2211,6 +2834,10 @@ </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.struct">struct() (in module datafusion.functions)</a> </li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter.style_provider">style_provider (datafusion.html_formatter.DataFrameHtmlFormatter attribute)</a> +</li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.StyleProvider">StyleProvider (class in datafusion.html_formatter)</a> +</li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Subquery">Subquery (in module datafusion.expr)</a> </li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.SubqueryAlias">SubqueryAlias (in module datafusion.expr)</a> @@ -2223,7 +2850,7 @@ </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.sum">sum() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.WindowEvaluator.supports_bounded_execution">supports_bounded_execution() (datafusion.udf.WindowEvaluator method)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.WindowEvaluator.supports_bounded_execution">supports_bounded_execution() (datafusion.user_defined.WindowEvaluator method)</a> </li> </ul></td> </tr></table> @@ -2253,20 +2880,44 @@ </ul></li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionContext.table_exist">table_exist() (datafusion.context.SessionContext method)</a> </li> + <li><a href="autoapi/datafusion/index.html#datafusion.TableFunction">TableFunction (class in datafusion)</a> + + <ul> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.TableFunction">(class in datafusion.user_defined)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.TableProviderExportable">TableProviderExportable (class in datafusion.context)</a> </li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.TableScan">TableScan (in module datafusion.expr)</a> </li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.tail">tail() (datafusion.dataframe.DataFrame method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.tan">tan() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.tan">tan() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.tan">(datafusion.expr.Expr method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.tanh">tanh() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.tan">(in module datafusion.functions)</a> </li> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.tanh">tanh() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.tanh">(datafusion.expr.Expr method)</a> +</li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.tanh">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.to_arrow_table">to_arrow_table() (datafusion.dataframe.DataFrame method)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.to_hex">to_hex() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.to_hex">to_hex() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.to_hex">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.to_hex">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.to_pandas">to_pandas() (datafusion.dataframe.DataFrame method)</a> </li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.to_polars">to_polars() (datafusion.dataframe.DataFrame method)</a> @@ -2317,12 +2968,28 @@ <li><a href="autoapi/datafusion/plan/index.html#datafusion.plan.LogicalPlan.to_variant">(datafusion.plan.LogicalPlan method)</a> </li> </ul></li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.TransactionAccessMode">TransactionAccessMode (in module datafusion.expr)</a> +</li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.TransactionConclusion">TransactionConclusion (in module datafusion.expr)</a> +</li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.TransactionEnd">TransactionEnd (in module datafusion.expr)</a> +</li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.TransactionIsolationLevel">TransactionIsolationLevel (in module datafusion.expr)</a> +</li> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.TransactionStart">TransactionStart (in module datafusion.expr)</a> +</li> <li><a href="autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.transform">transform() (datafusion.dataframe.DataFrame method)</a> </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.translate">translate() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.trim">trim() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.trim">trim() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.trim">(datafusion.expr.Expr method)</a> </li> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.trim">(in module datafusion.functions)</a> +</li> + </ul></li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.trunc">trunc() (in module datafusion.functions)</a> </li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.TryCast">TryCast (in module datafusion.expr)</a> @@ -2342,34 +3009,46 @@ <li><a href="autoapi/datafusion/index.html#datafusion.udaf">udaf (in module datafusion)</a> <ul> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.udaf">(in module datafusion.udf)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.udaf">(in module datafusion.user_defined)</a> </li> </ul></li> <li><a href="autoapi/datafusion/index.html#datafusion.AggregateUDF.udaf">udaf() (datafusion.AggregateUDF static method)</a> <ul> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.AggregateUDF.udaf">(datafusion.udf.AggregateUDF static method)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.AggregateUDF.udaf">(datafusion.user_defined.AggregateUDF static method)</a> </li> </ul></li> <li><a href="autoapi/datafusion/index.html#datafusion.udf">udf (in module datafusion)</a> <ul> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.udf">(in module datafusion.udf)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.udf">(in module datafusion.user_defined)</a> </li> </ul></li> <li><a href="autoapi/datafusion/index.html#datafusion.ScalarUDF.udf">udf() (datafusion.ScalarUDF static method)</a> <ul> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.ScalarUDF.udf">(datafusion.udf.ScalarUDF static method)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.ScalarUDF.udf">(datafusion.user_defined.ScalarUDF static method)</a> +</li> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.udtf">udtf (in module datafusion)</a> + + <ul> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.udtf">(in module datafusion.user_defined)</a> +</li> + </ul></li> + <li><a href="autoapi/datafusion/index.html#datafusion.TableFunction.udtf">udtf() (datafusion.TableFunction static method)</a> + + <ul> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.TableFunction.udtf">(datafusion.user_defined.TableFunction static method)</a> </li> </ul></li> <li><a href="autoapi/datafusion/index.html#datafusion.udwf">udwf (in module datafusion)</a> <ul> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.udwf">(in module datafusion.udf)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.udwf">(in module datafusion.user_defined)</a> </li> </ul></li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.WindowUDF.udwf">udwf() (datafusion.udf.WindowUDF static method)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.WindowUDF.udwf">udwf() (datafusion.user_defined.WindowUDF static method)</a> <ul> <li><a href="autoapi/datafusion/index.html#datafusion.WindowUDF.udwf">(datafusion.WindowUDF static method)</a> @@ -2391,15 +3070,27 @@ </li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.UnnestExpr">UnnestExpr (in module datafusion.expr)</a> </li> + <li><a href="autoapi/datafusion/unparser/index.html#datafusion.unparser.Unparser">Unparser (class in datafusion.unparser)</a> +</li> + <li><a href="autoapi/datafusion/unparser/index.html#datafusion.unparser.Unparser.unparser">unparser (datafusion.unparser.Unparser attribute)</a> +</li> <li><a href="autoapi/datafusion/index.html#datafusion.Accumulator.update">update() (datafusion.Accumulator method)</a> <ul> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.Accumulator.update">(datafusion.udf.Accumulator method)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.Accumulator.update">(datafusion.user_defined.Accumulator method)</a> </li> </ul></li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.upper">upper() (in module datafusion.functions)</a> + <li><a href="autoapi/datafusion/index.html#datafusion.Expr.upper">upper() (datafusion.Expr method)</a> + + <ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.upper">(datafusion.expr.Expr method)</a> </li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.WindowEvaluator.uses_window_frame">uses_window_frame() (datafusion.udf.WindowEvaluator method)</a> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.upper">(in module datafusion.functions)</a> +</li> + </ul></li> + <li><a href="autoapi/datafusion/html_formatter/index.html#datafusion.html_formatter.DataFrameHtmlFormatter.use_shared_styles">use_shared_styles (datafusion.html_formatter.DataFrameHtmlFormatter attribute)</a> +</li> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.WindowEvaluator.uses_window_frame">uses_window_frame() (datafusion.user_defined.WindowEvaluator method)</a> </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.uuid">uuid() (in module datafusion.functions)</a> </li> @@ -2409,25 +3100,27 @@ <h2 id="V">V</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Values">Values (in module datafusion.expr)</a> +</li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.var">var() (in module datafusion.functions)</a> </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.var_pop">var_pop() (in module datafusion.functions)</a> </li> <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.var_samp">var_samp() (in module datafusion.functions)</a> </li> - <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.var_sample">var_sample() (in module datafusion.functions)</a> -</li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="autoapi/datafusion/functions/index.html#datafusion.functions.var_sample">var_sample() (in module datafusion.functions)</a> +</li> <li><a href="autoapi/datafusion/index.html#datafusion.Expr.variant_name">variant_name() (datafusion.Expr method)</a> <ul> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.variant_name">(datafusion.expr.Expr method)</a> </li> </ul></li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.Volatility.Volatile">Volatile (datafusion.udf.Volatility attribute)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.Volatility.Volatile">Volatile (datafusion.user_defined.Volatility attribute)</a> </li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.Volatility">Volatility (class in datafusion.udf)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.Volatility">Volatility (class in datafusion.user_defined)</a> </li> </ul></td> </tr></table> @@ -2457,7 +3150,7 @@ <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.Expr.window_frame">(datafusion.expr.Expr method)</a> </li> </ul></li> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.WindowEvaluator">WindowEvaluator (class in datafusion.udf)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.WindowEvaluator">WindowEvaluator (class in datafusion.user_defined)</a> </li> <li><a href="autoapi/datafusion/expr/index.html#datafusion.expr.WindowExpr">WindowExpr (in module datafusion.expr)</a> </li> @@ -2472,7 +3165,7 @@ <li><a href="autoapi/datafusion/index.html#datafusion.WindowUDF">WindowUDF (class in datafusion)</a> <ul> - <li><a href="autoapi/datafusion/udf/index.html#datafusion.udf.WindowUDF">(class in datafusion.udf)</a> + <li><a href="autoapi/datafusion/user_defined/index.html#datafusion.user_defined.WindowUDF">(class in datafusion.user_defined)</a> </li> </ul></li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SQLOptions.with_allow_ddl">with_allow_ddl() (datafusion.context.SQLOptions method)</a> @@ -2523,14 +3216,14 @@ <li><a href="autoapi/datafusion/index.html#datafusion.RuntimeEnvBuilder.with_disk_manager_disabled">(datafusion.RuntimeEnvBuilder method)</a> </li> </ul></li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.RuntimeEnvBuilder.with_disk_manager_os">with_disk_manager_os() (datafusion.context.RuntimeEnvBuilder method)</a> <ul> <li><a href="autoapi/datafusion/index.html#datafusion.RuntimeEnvBuilder.with_disk_manager_os">(datafusion.RuntimeEnvBuilder method)</a> </li> </ul></li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.RuntimeEnvBuilder.with_disk_manager_specified">with_disk_manager_specified() (datafusion.context.RuntimeEnvBuilder method)</a> <ul> @@ -2561,6 +3254,8 @@ <li><a href="autoapi/datafusion/index.html#datafusion.SessionConfig.with_parquet_pruning">(datafusion.SessionConfig method)</a> </li> </ul></li> + <li><a href="autoapi/datafusion/unparser/index.html#datafusion.unparser.Unparser.with_pretty">with_pretty() (datafusion.unparser.Unparser method)</a> +</li> <li><a href="autoapi/datafusion/context/index.html#datafusion.context.SessionConfig.with_repartition_aggregations">with_repartition_aggregations() (datafusion.context.SessionConfig method)</a> <ul>
diff --git a/index.html b/index.html index 2753909..e143b33 100644 --- a/index.html +++ b/index.html
@@ -116,6 +116,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="user-guide/common-operations/index.html"> Common Operations @@ -275,6 +280,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -294,6 +304,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="autoapi/datafusion/input/index.html"> datafusion.input @@ -346,6 +361,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/objects.inv b/objects.inv index b945840..da03cab 100644 --- a/objects.inv +++ b/objects.inv Binary files differ
diff --git a/py-modindex.html b/py-modindex.html index 05bc2ec..997fa80 100644 --- a/py-modindex.html +++ b/py-modindex.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="user-guide/common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul> @@ -402,6 +427,11 @@ <tr class="cg-1"> <td></td> <td>    + <a href="autoapi/datafusion/col/index.html#module-datafusion.col"><code class="xref">datafusion.col</code></a></td><td> + <em></em></td></tr> + <tr class="cg-1"> + <td></td> + <td>    <a href="autoapi/datafusion/context/index.html#module-datafusion.context"><code class="xref">datafusion.context</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> @@ -422,6 +452,11 @@ <tr class="cg-1"> <td></td> <td>    + <a href="autoapi/datafusion/html_formatter/index.html#module-datafusion.html_formatter"><code class="xref">datafusion.html_formatter</code></a></td><td> + <em></em></td></tr> + <tr class="cg-1"> + <td></td> + <td>    <a href="autoapi/datafusion/input/index.html#module-datafusion.input"><code class="xref">datafusion.input</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> @@ -464,6 +499,16 @@ <td>    <a href="autoapi/datafusion/udf/index.html#module-datafusion.udf"><code class="xref">datafusion.udf</code></a></td><td> <em></em></td></tr> + <tr class="cg-1"> + <td></td> + <td>    + <a href="autoapi/datafusion/unparser/index.html#module-datafusion.unparser"><code class="xref">datafusion.unparser</code></a></td><td> + <em></em></td></tr> + <tr class="cg-1"> + <td></td> + <td>    + <a href="autoapi/datafusion/user_defined/index.html#module-datafusion.user_defined"><code class="xref">datafusion.user_defined</code></a></td><td> + <em></em></td></tr> </table>
diff --git a/search.html b/search.html index 6461c91..6602d8b 100644 --- a/search.html +++ b/search.html
@@ -121,6 +121,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="user-guide/dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="user-guide/common-operations/index.html"> Common Operations @@ -280,6 +285,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -299,6 +309,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="autoapi/datafusion/input/index.html"> datafusion.input @@ -351,6 +366,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/searchindex.js b/searchindex.js index 143eae6..bd9247e 100644 --- a/searchindex.js +++ b/searchindex.js
@@ -1 +1 @@ -Search.setIndex({"alltitles": {"API Reference": [[15, null]], "Aggregate Functions": [[20, "aggregate-functions"], [27, "aggregate-functions"], [29, "aggregate-functions"]], "Aggregation": [[20, null]], "Alternative Approach": [[16, "alternative-approach"]], "Arrays": [[22, "arrays"]], "Arrow": [[33, null]], "Attributes": [[3, "attributes"], [5, "attributes"], [10, "attributes"], [14, "attributes"]], "Available Functions": [[29, "available-functions"]], "Avro": [[34, null]], "Basic Operations": [[21, null]], "Boolean": [[22, "boolean"]], "CSV": [[35, null]], "Casting": [[23, "casting"]], "Classes": [[0, "classes"], [1, "classes"], [2, "classes"], [3, "classes"], [5, "classes"], [6, "classes"], [7, "classes"], [8, "classes"], [11, "classes"], [12, "classes"], [13, "classes"], [14, "classes"]], "Column": [[22, "column"]], "Column Selections": [[26, null]], "Common Operations": [[24, null]], "Concepts": [[19, null]], "Conditional": [[23, "conditional"]], "Configuration": [[30, null]], "Create in-memory": [[31, "create-in-memory"]], "Custom Table Provider": [[31, "custom-table-provider"], [39, null]], "Data Sources": [[31, null]], "DataFrame": [[19, "dataframe"]], "DataFusion in Python": [[18, null]], "Delta Lake": [[31, "delta-lake"]], "Distinct": [[20, "distinct"]], "Example": [[18, "example"]], "Exporting from DataFusion": [[33, "exporting-from-datafusion"]], "Expressions": [[19, "expressions"], [22, null]], "Filter": [[20, "filter"]], "Full Join": [[25, "full-join"]], "Functions": [[4, "functions"], [5, "functions"], [9, "functions"], [22, "functions"], [23, null]], "Guidelines for Separating Python and Rust Code": [[17, "guidelines-for-separating-python-and-rust-code"]], "How to develop": [[17, "how-to-develop"]], "IO": [[36, null]], "Iceberg": [[31, "iceberg"]], "Implementation Details": [[16, "implementation-details"]], "Importing to DataFusion": [[33, "importing-to-datafusion"]], "Improving Build Speed": [[17, "improving-build-speed"]], "Inner Join": [[25, "inner-join"]], "Inspiration from Arrow": [[16, "inspiration-from-arrow"]], "Install": [[18, "install"]], "Installation": [[32, "installation"]], "Introduction": [[17, null], [32, null]], "JSON": [[37, null]], "Joins": [[25, null]], "Left Anti Join": [[25, "left-anti-join"]], "Left Join": [[25, "left-join"]], "Left Semi Join": [[25, "left-semi-join"]], "Literal": [[22, "literal"]], "Local file": [[31, "local-file"]], "Mathematical": [[23, "mathematical"]], "Module Contents": [[0, "module-contents"], [1, "module-contents"], [2, "module-contents"], [3, "module-contents"], [4, "module-contents"], [6, "module-contents"], [8, "module-contents"], [9, "module-contents"], [10, "module-contents"], [11, "module-contents"], [12, "module-contents"], [13, "module-contents"], [14, "module-contents"]], "Null Treatment": [[20, "null-treatment"], [29, "null-treatment"]], "Object Store": [[31, "object-store"]], "Ordering": [[20, "ordering"], [29, "ordering"]], "Other": [[23, "other"]], "Other DataFrame Libraries": [[31, "other-dataframe-libraries"]], "Package Contents": [[5, "package-contents"], [7, "package-contents"]], "Parquet": [[38, null]], "Partitions": [[29, "partitions"]], "Python Extensions": [[16, null]], "Registering Views": [[28, null]], "Returns:": [[4, "returns"], [4, "id1"]], "Running & Installing pre-commit hooks": [[17, "running-installing-pre-commit-hooks"]], "SQL": [[40, null]], "Scalar Functions": [[27, "scalar-functions"]], "Session Context": [[19, "session-context"]], "Setting Parameters": [[20, "setting-parameters"], [29, "setting-parameters"]], "Status of Work": [[16, "status-of-work"]], "String": [[23, "string"]], "Structs": [[22, "structs"]], "Submodules": [[5, "submodules"], [7, "submodules"]], "Temporal": [[23, "temporal"]], "The FFI Approach": [[16, "the-ffi-approach"]], "The Primary Issue": [[16, "the-primary-issue"]], "UDWF options": [[27, "udwf-options"]], "Update Dependencies": [[17, "update-dependencies"]], "User-Defined Functions": [[27, null]], "Window Frame": [[29, "window-frame"]], "Window Functions": [[27, "window-functions"], [29, null]], "datafusion": [[5, null]], "datafusion.catalog": [[0, null]], "datafusion.context": [[1, null]], "datafusion.dataframe": [[2, null]], "datafusion.expr": [[3, null]], "datafusion.functions": [[4, null]], "datafusion.input": [[7, null]], "datafusion.input.base": [[6, null]], "datafusion.input.location": [[8, null]], "datafusion.io": [[9, null]], "datafusion.object_store": [[10, null]], "datafusion.plan": [[11, null]], "datafusion.record_batch": [[12, null]], "datafusion.substrait": [[13, null]], "datafusion.udf": [[14, null]]}, "docnames": ["autoapi/datafusion/catalog/index", "autoapi/datafusion/context/index", "autoapi/datafusion/dataframe/index", "autoapi/datafusion/expr/index", "autoapi/datafusion/functions/index", "autoapi/datafusion/index", "autoapi/datafusion/input/base/index", "autoapi/datafusion/input/index", "autoapi/datafusion/input/location/index", "autoapi/datafusion/io/index", "autoapi/datafusion/object_store/index", "autoapi/datafusion/plan/index", "autoapi/datafusion/record_batch/index", "autoapi/datafusion/substrait/index", "autoapi/datafusion/udf/index", "autoapi/index", "contributor-guide/ffi", "contributor-guide/introduction", "index", "user-guide/basics", "user-guide/common-operations/aggregations", "user-guide/common-operations/basic-info", "user-guide/common-operations/expressions", "user-guide/common-operations/functions", "user-guide/common-operations/index", "user-guide/common-operations/joins", "user-guide/common-operations/select-and-filter", "user-guide/common-operations/udf-and-udfa", "user-guide/common-operations/views", "user-guide/common-operations/windows", "user-guide/configuration", "user-guide/data-sources", "user-guide/introduction", "user-guide/io/arrow", "user-guide/io/avro", "user-guide/io/csv", "user-guide/io/index", "user-guide/io/json", "user-guide/io/parquet", "user-guide/io/table_provider", "user-guide/sql"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["autoapi/datafusion/catalog/index.rst", "autoapi/datafusion/context/index.rst", "autoapi/datafusion/dataframe/index.rst", "autoapi/datafusion/expr/index.rst", "autoapi/datafusion/functions/index.rst", "autoapi/datafusion/index.rst", "autoapi/datafusion/input/base/index.rst", "autoapi/datafusion/input/index.rst", "autoapi/datafusion/input/location/index.rst", "autoapi/datafusion/io/index.rst", "autoapi/datafusion/object_store/index.rst", "autoapi/datafusion/plan/index.rst", "autoapi/datafusion/record_batch/index.rst", "autoapi/datafusion/substrait/index.rst", "autoapi/datafusion/udf/index.rst", "autoapi/index.rst", "contributor-guide/ffi.rst", "contributor-guide/introduction.rst", "index.rst", "user-guide/basics.rst", "user-guide/common-operations/aggregations.rst", "user-guide/common-operations/basic-info.rst", "user-guide/common-operations/expressions.rst", "user-guide/common-operations/functions.rst", "user-guide/common-operations/index.rst", "user-guide/common-operations/joins.rst", "user-guide/common-operations/select-and-filter.rst", "user-guide/common-operations/udf-and-udfa.rst", "user-guide/common-operations/views.rst", "user-guide/common-operations/windows.rst", "user-guide/configuration.rst", "user-guide/data-sources.rst", "user-guide/introduction.rst", "user-guide/io/arrow.rst", "user-guide/io/avro.rst", "user-guide/io/csv.rst", "user-guide/io/index.rst", "user-guide/io/json.rst", "user-guide/io/parquet.rst", "user-guide/io/table_provider.rst", "user-guide/sql.rst"], "indexentries": {"__add__() (datafusion.expr method)": [[5, "datafusion.Expr.__add__", false]], "__add__() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.__add__", false]], "__aiter__() (datafusion.record_batch.recordbatchstream method)": [[12, "datafusion.record_batch.RecordBatchStream.__aiter__", false]], "__aiter__() (datafusion.recordbatchstream method)": [[5, "datafusion.RecordBatchStream.__aiter__", false]], "__and__() (datafusion.expr method)": [[5, "datafusion.Expr.__and__", false]], "__and__() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.__and__", false]], "__anext__() (datafusion.record_batch.recordbatchstream method)": [[12, "datafusion.record_batch.RecordBatchStream.__anext__", false]], "__anext__() (datafusion.recordbatchstream method)": [[5, "datafusion.RecordBatchStream.__anext__", false]], "__arrow_c_array__() (datafusion.context.arrowarrayexportable method)": [[1, "datafusion.context.ArrowArrayExportable.__arrow_c_array__", false]], "__arrow_c_stream__() (datafusion.context.arrowstreamexportable method)": [[1, "datafusion.context.ArrowStreamExportable.__arrow_c_stream__", false]], "__arrow_c_stream__() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.__arrow_c_stream__", false]], "__call__() (datafusion.aggregateudf method)": [[5, "datafusion.AggregateUDF.__call__", false]], "__call__() (datafusion.scalarudf method)": [[5, "datafusion.ScalarUDF.__call__", false]], "__call__() (datafusion.udf.aggregateudf method)": [[14, "datafusion.udf.AggregateUDF.__call__", false]], "__call__() (datafusion.udf.scalarudf method)": [[14, "datafusion.udf.ScalarUDF.__call__", false]], "__call__() (datafusion.udf.windowudf method)": [[14, "datafusion.udf.WindowUDF.__call__", false]], "__call__() (datafusion.windowudf method)": [[5, "datafusion.WindowUDF.__call__", false]], "__datafusion_table_provider__() (datafusion.context.tableproviderexportable method)": [[1, "datafusion.context.TableProviderExportable.__datafusion_table_provider__", false]], "__eq__() (datafusion.expr method)": [[5, "datafusion.Expr.__eq__", false]], "__eq__() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.__eq__", false]], "__ge__() (datafusion.expr method)": [[5, "datafusion.Expr.__ge__", false]], "__ge__() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.__ge__", false]], "__getitem__() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.__getitem__", false]], "__getitem__() (datafusion.expr method)": [[5, "datafusion.Expr.__getitem__", false]], "__getitem__() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.__getitem__", false]], "__gt__() (datafusion.expr method)": [[5, "datafusion.Expr.__gt__", false]], "__gt__() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.__gt__", false]], "__invert__() (datafusion.expr method)": [[5, "datafusion.Expr.__invert__", false]], "__invert__() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.__invert__", false]], "__iter__() (datafusion.record_batch.recordbatchstream method)": [[12, "datafusion.record_batch.RecordBatchStream.__iter__", false]], "__iter__() (datafusion.recordbatchstream method)": [[5, "datafusion.RecordBatchStream.__iter__", false]], "__le__() (datafusion.expr method)": [[5, "datafusion.Expr.__le__", false]], "__le__() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.__le__", false]], "__lt__() (datafusion.expr method)": [[5, "datafusion.Expr.__lt__", false]], "__lt__() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.__lt__", false]], "__mod__() (datafusion.expr method)": [[5, "datafusion.Expr.__mod__", false]], "__mod__() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.__mod__", false]], "__mul__() (datafusion.expr method)": [[5, "datafusion.Expr.__mul__", false]], "__mul__() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.__mul__", false]], "__ne__() (datafusion.expr method)": [[5, "datafusion.Expr.__ne__", false]], "__ne__() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.__ne__", false]], "__next__() (datafusion.record_batch.recordbatchstream method)": [[12, "datafusion.record_batch.RecordBatchStream.__next__", false]], "__next__() (datafusion.recordbatchstream method)": [[5, "datafusion.RecordBatchStream.__next__", false]], "__or__() (datafusion.expr method)": [[5, "datafusion.Expr.__or__", false]], "__or__() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.__or__", false]], "__radd__ (datafusion.expr attribute)": [[5, "datafusion.Expr.__radd__", false]], "__radd__ (datafusion.expr.expr attribute)": [[3, "datafusion.expr.Expr.__radd__", false]], "__rand__ (datafusion.expr attribute)": [[5, "datafusion.Expr.__rand__", false]], "__rand__ (datafusion.expr.expr attribute)": [[3, "datafusion.expr.Expr.__rand__", false]], "__repr__() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.__repr__", false]], "__repr__() (datafusion.executionplan method)": [[5, "datafusion.ExecutionPlan.__repr__", false]], "__repr__() (datafusion.expr method)": [[5, "datafusion.Expr.__repr__", false]], "__repr__() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.__repr__", false]], "__repr__() (datafusion.expr.sortexpr method)": [[3, "datafusion.expr.SortExpr.__repr__", false]], "__repr__() (datafusion.logicalplan method)": [[5, "datafusion.LogicalPlan.__repr__", false]], "__repr__() (datafusion.plan.executionplan method)": [[11, "datafusion.plan.ExecutionPlan.__repr__", false]], "__repr__() (datafusion.plan.logicalplan method)": [[11, "datafusion.plan.LogicalPlan.__repr__", false]], "__richcmp__() (datafusion.expr method)": [[5, "datafusion.Expr.__richcmp__", false]], "__richcmp__() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.__richcmp__", false]], "__rmod__ (datafusion.expr attribute)": [[5, "datafusion.Expr.__rmod__", false]], "__rmod__ (datafusion.expr.expr attribute)": [[3, "datafusion.expr.Expr.__rmod__", false]], "__rmul__ (datafusion.expr attribute)": [[5, "datafusion.Expr.__rmul__", false]], "__rmul__ (datafusion.expr.expr attribute)": [[3, "datafusion.expr.Expr.__rmul__", false]], "__ror__ (datafusion.expr attribute)": [[5, "datafusion.Expr.__ror__", false]], "__ror__ (datafusion.expr.expr attribute)": [[3, "datafusion.expr.Expr.__ror__", false]], "__rsub__ (datafusion.expr attribute)": [[5, "datafusion.Expr.__rsub__", false]], "__rsub__ (datafusion.expr.expr attribute)": [[3, "datafusion.expr.Expr.__rsub__", false]], "__rtruediv__ (datafusion.expr attribute)": [[5, "datafusion.Expr.__rtruediv__", false]], "__rtruediv__ (datafusion.expr.expr attribute)": [[3, "datafusion.expr.Expr.__rtruediv__", false]], "__str__() (datafusion.udf.volatility method)": [[14, "datafusion.udf.Volatility.__str__", false]], "__sub__() (datafusion.expr method)": [[5, "datafusion.Expr.__sub__", false]], "__sub__() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.__sub__", false]], "__truediv__() (datafusion.expr method)": [[5, "datafusion.Expr.__truediv__", false]], "__truediv__() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.__truediv__", false]], "_create_window_udf() (datafusion.udf.windowudf static method)": [[14, "datafusion.udf.WindowUDF._create_window_udf", false]], "_create_window_udf() (datafusion.windowudf static method)": [[5, "datafusion.WindowUDF._create_window_udf", false]], "_create_window_udf_decorator() (datafusion.udf.windowudf static method)": [[14, "datafusion.udf.WindowUDF._create_window_udf_decorator", false]], "_create_window_udf_decorator() (datafusion.windowudf static method)": [[5, "datafusion.WindowUDF._create_window_udf_decorator", false]], "_get_default_name() (datafusion.udf.windowudf static method)": [[14, "datafusion.udf.WindowUDF._get_default_name", false]], "_get_default_name() (datafusion.windowudf static method)": [[5, "datafusion.WindowUDF._get_default_name", false]], "_normalize_input_types() (datafusion.udf.windowudf static method)": [[14, "datafusion.udf.WindowUDF._normalize_input_types", false]], "_normalize_input_types() (datafusion.windowudf static method)": [[5, "datafusion.WindowUDF._normalize_input_types", false]], "_null_treatment (datafusion.expr.window attribute)": [[3, "datafusion.expr.Window._null_treatment", false]], "_order_by (datafusion.expr.window attribute)": [[3, "datafusion.expr.Window._order_by", false]], "_partition_by (datafusion.expr.window attribute)": [[3, "datafusion.expr.Window._partition_by", false]], "_r (in module datafusion.udf)": [[14, "datafusion.udf._R", false]], "_raw_plan (datafusion.executionplan attribute)": [[5, "datafusion.ExecutionPlan._raw_plan", false]], "_raw_plan (datafusion.logicalplan attribute)": [[5, "datafusion.LogicalPlan._raw_plan", false]], "_raw_plan (datafusion.plan.executionplan attribute)": [[11, "datafusion.plan.ExecutionPlan._raw_plan", false]], "_raw_plan (datafusion.plan.logicalplan attribute)": [[11, "datafusion.plan.LogicalPlan._raw_plan", false]], "_repr_html_() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame._repr_html_", false]], "_to_pyarrow_types (datafusion.expr attribute)": [[5, "datafusion.Expr._to_pyarrow_types", false]], "_to_pyarrow_types (datafusion.expr.expr attribute)": [[3, "datafusion.expr.Expr._to_pyarrow_types", false]], "_udaf (datafusion.aggregateudf attribute)": [[5, "datafusion.AggregateUDF._udaf", false]], "_udaf (datafusion.udf.aggregateudf attribute)": [[14, "datafusion.udf.AggregateUDF._udaf", false]], "_udf (datafusion.scalarudf attribute)": [[5, "datafusion.ScalarUDF._udf", false]], "_udf (datafusion.udf.scalarudf attribute)": [[14, "datafusion.udf.ScalarUDF._udf", false]], "_udwf (datafusion.udf.windowudf attribute)": [[14, "datafusion.udf.WindowUDF._udwf", false]], "_udwf (datafusion.windowudf attribute)": [[5, "datafusion.WindowUDF._udwf", false]], "_window_frame (datafusion.expr.window attribute)": [[3, "datafusion.expr.Window._window_frame", false]], "abs() (in module datafusion.functions)": [[4, "datafusion.functions.abs", false]], "accumulator (class in datafusion)": [[5, "datafusion.Accumulator", false]], "accumulator (class in datafusion.udf)": [[14, "datafusion.udf.Accumulator", false]], "acos() (in module datafusion.functions)": [[4, "datafusion.functions.acos", false]], "acosh() (in module datafusion.functions)": [[4, "datafusion.functions.acosh", false]], "aggregate (in module datafusion.expr)": [[3, "datafusion.expr.Aggregate", false]], "aggregate() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.aggregate", false]], "aggregatefunction (in module datafusion.expr)": [[3, "datafusion.expr.AggregateFunction", false]], "aggregateudf (class in datafusion)": [[5, "datafusion.AggregateUDF", false]], "aggregateudf (class in datafusion.udf)": [[14, "datafusion.udf.AggregateUDF", false]], "alias (in module datafusion.expr)": [[3, "datafusion.expr.Alias", false]], "alias() (datafusion.expr method)": [[5, "datafusion.Expr.alias", false]], "alias() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.alias", false]], "alias() (in module datafusion.functions)": [[4, "datafusion.functions.alias", false]], "amazons3 (in module datafusion.object_store)": [[10, "datafusion.object_store.AmazonS3", false]], "analyze (in module datafusion.expr)": [[3, "datafusion.expr.Analyze", false]], "approx_distinct() (in module datafusion.functions)": [[4, "datafusion.functions.approx_distinct", false]], "approx_median() (in module datafusion.functions)": [[4, "datafusion.functions.approx_median", false]], "approx_percentile_cont() (in module datafusion.functions)": [[4, "datafusion.functions.approx_percentile_cont", false]], "approx_percentile_cont_with_weight() (in module datafusion.functions)": [[4, "datafusion.functions.approx_percentile_cont_with_weight", false]], "array() (in module datafusion.functions)": [[4, "datafusion.functions.array", false]], "array_agg() (in module datafusion.functions)": [[4, "datafusion.functions.array_agg", false]], "array_append() (in module datafusion.functions)": [[4, "datafusion.functions.array_append", false]], "array_cat() (in module datafusion.functions)": [[4, "datafusion.functions.array_cat", false]], "array_concat() (in module datafusion.functions)": [[4, "datafusion.functions.array_concat", false]], "array_dims() (in module datafusion.functions)": [[4, "datafusion.functions.array_dims", false]], "array_distinct() (in module datafusion.functions)": [[4, "datafusion.functions.array_distinct", false]], "array_element() (in module datafusion.functions)": [[4, "datafusion.functions.array_element", false]], "array_empty() (in module datafusion.functions)": [[4, "datafusion.functions.array_empty", false]], "array_except() (in module datafusion.functions)": [[4, "datafusion.functions.array_except", false]], "array_extract() (in module datafusion.functions)": [[4, "datafusion.functions.array_extract", false]], "array_has() (in module datafusion.functions)": [[4, "datafusion.functions.array_has", false]], "array_has_all() (in module datafusion.functions)": [[4, "datafusion.functions.array_has_all", false]], "array_has_any() (in module datafusion.functions)": [[4, "datafusion.functions.array_has_any", false]], "array_indexof() (in module datafusion.functions)": [[4, "datafusion.functions.array_indexof", false]], "array_intersect() (in module datafusion.functions)": [[4, "datafusion.functions.array_intersect", false]], "array_join() (in module datafusion.functions)": [[4, "datafusion.functions.array_join", false]], "array_length() (in module datafusion.functions)": [[4, "datafusion.functions.array_length", false]], "array_ndims() (in module datafusion.functions)": [[4, "datafusion.functions.array_ndims", false]], "array_pop_back() (in module datafusion.functions)": [[4, "datafusion.functions.array_pop_back", false]], "array_pop_front() (in module datafusion.functions)": [[4, "datafusion.functions.array_pop_front", false]], "array_position() (in module datafusion.functions)": [[4, "datafusion.functions.array_position", false]], "array_positions() (in module datafusion.functions)": [[4, "datafusion.functions.array_positions", false]], "array_prepend() (in module datafusion.functions)": [[4, "datafusion.functions.array_prepend", false]], "array_push_back() (in module datafusion.functions)": [[4, "datafusion.functions.array_push_back", false]], "array_push_front() (in module datafusion.functions)": [[4, "datafusion.functions.array_push_front", false]], "array_remove() (in module datafusion.functions)": [[4, "datafusion.functions.array_remove", false]], "array_remove_all() (in module datafusion.functions)": [[4, "datafusion.functions.array_remove_all", false]], "array_remove_n() (in module datafusion.functions)": [[4, "datafusion.functions.array_remove_n", false]], "array_repeat() (in module datafusion.functions)": [[4, "datafusion.functions.array_repeat", false]], "array_replace() (in module datafusion.functions)": [[4, "datafusion.functions.array_replace", false]], "array_replace_all() (in module datafusion.functions)": [[4, "datafusion.functions.array_replace_all", false]], "array_replace_n() (in module datafusion.functions)": [[4, "datafusion.functions.array_replace_n", false]], "array_resize() (in module datafusion.functions)": [[4, "datafusion.functions.array_resize", false]], "array_slice() (in module datafusion.functions)": [[4, "datafusion.functions.array_slice", false]], "array_sort() (in module datafusion.functions)": [[4, "datafusion.functions.array_sort", false]], "array_to_string() (in module datafusion.functions)": [[4, "datafusion.functions.array_to_string", false]], "array_union() (in module datafusion.functions)": [[4, "datafusion.functions.array_union", false]], "arrow_cast() (in module datafusion.functions)": [[4, "datafusion.functions.arrow_cast", false]], "arrow_typeof() (in module datafusion.functions)": [[4, "datafusion.functions.arrow_typeof", false]], "arrowarrayexportable (class in datafusion.context)": [[1, "datafusion.context.ArrowArrayExportable", false]], "arrowstreamexportable (class in datafusion.context)": [[1, "datafusion.context.ArrowStreamExportable", false]], "ascending() (datafusion.expr.sortexpr method)": [[3, "datafusion.expr.SortExpr.ascending", false]], "ascii() (in module datafusion.functions)": [[4, "datafusion.functions.ascii", false]], "asin() (in module datafusion.functions)": [[4, "datafusion.functions.asin", false]], "asinh() (in module datafusion.functions)": [[4, "datafusion.functions.asinh", false]], "atan() (in module datafusion.functions)": [[4, "datafusion.functions.atan", false]], "atan2() (in module datafusion.functions)": [[4, "datafusion.functions.atan2", false]], "atanh() (in module datafusion.functions)": [[4, "datafusion.functions.atanh", false]], "avg() (in module datafusion.functions)": [[4, "datafusion.functions.avg", false]], "baseinputsource (class in datafusion.input.base)": [[6, "datafusion.input.base.BaseInputSource", false]], "between (in module datafusion.expr)": [[3, "datafusion.expr.Between", false]], "between() (datafusion.expr method)": [[5, "datafusion.Expr.between", false]], "between() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.between", false]], "binaryexpr (in module datafusion.expr)": [[3, "datafusion.expr.BinaryExpr", false]], "bit_and() (in module datafusion.functions)": [[4, "datafusion.functions.bit_and", false]], "bit_length() (in module datafusion.functions)": [[4, "datafusion.functions.bit_length", false]], "bit_or() (in module datafusion.functions)": [[4, "datafusion.functions.bit_or", false]], "bit_xor() (in module datafusion.functions)": [[4, "datafusion.functions.bit_xor", false]], "bool_and() (in module datafusion.functions)": [[4, "datafusion.functions.bool_and", false]], "bool_or() (in module datafusion.functions)": [[4, "datafusion.functions.bool_or", false]], "brotli (datafusion.dataframe.compression attribute)": [[2, "datafusion.dataframe.Compression.BROTLI", false]], "btrim() (in module datafusion.functions)": [[4, "datafusion.functions.btrim", false]], "build_table() (datafusion.input.base.baseinputsource method)": [[6, "datafusion.input.base.BaseInputSource.build_table", false]], "build_table() (datafusion.input.location.locationinputplugin method)": [[8, "datafusion.input.location.LocationInputPlugin.build_table", false]], "build_table() (datafusion.input.locationinputplugin method)": [[7, "datafusion.input.LocationInputPlugin.build_table", false]], "cache() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.cache", false]], "canonical_name() (datafusion.expr method)": [[5, "datafusion.Expr.canonical_name", false]], "canonical_name() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.canonical_name", false]], "cardinality() (in module datafusion.functions)": [[4, "datafusion.functions.cardinality", false]], "case (in module datafusion.expr)": [[3, "datafusion.expr.Case", false]], "case() (in module datafusion.functions)": [[4, "datafusion.functions.case", false]], "case_builder (datafusion.expr.casebuilder attribute)": [[3, "datafusion.expr.CaseBuilder.case_builder", false]], "casebuilder (class in datafusion.expr)": [[3, "datafusion.expr.CaseBuilder", false]], "cast (in module datafusion.expr)": [[3, "datafusion.expr.Cast", false]], "cast() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.cast", false]], "cast() (datafusion.expr method)": [[5, "datafusion.Expr.cast", false]], "cast() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.cast", false]], "catalog (class in datafusion)": [[5, "datafusion.Catalog", false]], "catalog (class in datafusion.catalog)": [[0, "datafusion.catalog.Catalog", false]], "catalog (datafusion.catalog attribute)": [[5, "datafusion.Catalog.catalog", false]], "catalog (datafusion.catalog.catalog attribute)": [[0, "datafusion.catalog.Catalog.catalog", false]], "catalog() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.catalog", false]], "cbrt() (in module datafusion.functions)": [[4, "datafusion.functions.cbrt", false]], "ceil() (in module datafusion.functions)": [[4, "datafusion.functions.ceil", false]], "char_length() (in module datafusion.functions)": [[4, "datafusion.functions.char_length", false]], "character_length() (in module datafusion.functions)": [[4, "datafusion.functions.character_length", false]], "children() (datafusion.executionplan method)": [[5, "datafusion.ExecutionPlan.children", false]], "children() (datafusion.plan.executionplan method)": [[11, "datafusion.plan.ExecutionPlan.children", false]], "chr() (in module datafusion.functions)": [[4, "datafusion.functions.chr", false]], "coalesce() (in module datafusion.functions)": [[4, "datafusion.functions.coalesce", false]], "col() (in module datafusion)": [[5, "datafusion.col", false]], "col() (in module datafusion.functions)": [[4, "datafusion.functions.col", false]], "collect() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.collect", false]], "collect_partitioned() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.collect_partitioned", false]], "column (in module datafusion.expr)": [[3, "datafusion.expr.Column", false]], "column() (datafusion.expr static method)": [[5, "datafusion.Expr.column", false]], "column() (datafusion.expr.expr static method)": [[3, "datafusion.expr.Expr.column", false]], "column() (in module datafusion)": [[5, "datafusion.column", false]], "column_name() (datafusion.expr method)": [[5, "datafusion.Expr.column_name", false]], "column_name() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.column_name", false]], "compression (class in datafusion.dataframe)": [[2, "datafusion.dataframe.Compression", false]], "concat() (in module datafusion.functions)": [[4, "datafusion.functions.concat", false]], "concat_ws() (in module datafusion.functions)": [[4, "datafusion.functions.concat_ws", false]], "config_internal (datafusion.context.runtimeenvbuilder attribute)": [[1, "datafusion.context.RuntimeEnvBuilder.config_internal", false]], "config_internal (datafusion.context.sessionconfig attribute)": [[1, "datafusion.context.SessionConfig.config_internal", false]], "config_internal (datafusion.runtimeenvbuilder attribute)": [[5, "datafusion.RuntimeEnvBuilder.config_internal", false]], "config_internal (datafusion.sessionconfig attribute)": [[5, "datafusion.SessionConfig.config_internal", false]], "consumer (class in datafusion.substrait)": [[13, "datafusion.substrait.Consumer", false]], "corr() (in module datafusion.functions)": [[4, "datafusion.functions.corr", false]], "cos() (in module datafusion.functions)": [[4, "datafusion.functions.cos", false]], "cosh() (in module datafusion.functions)": [[4, "datafusion.functions.cosh", false]], "cot() (in module datafusion.functions)": [[4, "datafusion.functions.cot", false]], "count() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.count", false]], "count() (in module datafusion.functions)": [[4, "datafusion.functions.count", false]], "count_star() (in module datafusion.functions)": [[4, "datafusion.functions.count_star", false]], "covar() (in module datafusion.functions)": [[4, "datafusion.functions.covar", false]], "covar_pop() (in module datafusion.functions)": [[4, "datafusion.functions.covar_pop", false]], "covar_samp() (in module datafusion.functions)": [[4, "datafusion.functions.covar_samp", false]], "create_dataframe() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.create_dataframe", false]], "create_dataframe_from_logical_plan() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.create_dataframe_from_logical_plan", false]], "creatememorytable (in module datafusion.expr)": [[3, "datafusion.expr.CreateMemoryTable", false]], "createview (in module datafusion.expr)": [[3, "datafusion.expr.CreateView", false]], "ctx (datafusion.context.sessioncontext attribute)": [[1, "datafusion.context.SessionContext.ctx", false]], "cume_dist() (in module datafusion.functions)": [[4, "datafusion.functions.cume_dist", false]], "current_date() (in module datafusion.functions)": [[4, "datafusion.functions.current_date", false]], "current_time() (in module datafusion.functions)": [[4, "datafusion.functions.current_time", false]], "database (class in datafusion)": [[5, "datafusion.Database", false]], "database (class in datafusion.catalog)": [[0, "datafusion.catalog.Database", false]], "database() (datafusion.catalog method)": [[5, "datafusion.Catalog.database", false]], "database() (datafusion.catalog.catalog method)": [[0, "datafusion.catalog.Catalog.database", false]], "dataframe (class in datafusion.dataframe)": [[2, "datafusion.dataframe.DataFrame", false]], "datafusion": [[5, "module-datafusion", false]], "datafusion.catalog": [[0, "module-datafusion.catalog", false]], "datafusion.context": [[1, "module-datafusion.context", false]], "datafusion.dataframe": [[2, "module-datafusion.dataframe", false]], "datafusion.expr": [[3, "module-datafusion.expr", false]], "datafusion.functions": [[4, "module-datafusion.functions", false]], "datafusion.input": [[7, "module-datafusion.input", false]], "datafusion.input.base": [[6, "module-datafusion.input.base", false]], "datafusion.input.location": [[8, "module-datafusion.input.location", false]], "datafusion.io": [[9, "module-datafusion.io", false]], "datafusion.object_store": [[10, "module-datafusion.object_store", false]], "datafusion.plan": [[11, "module-datafusion.plan", false]], "datafusion.record_batch": [[12, "module-datafusion.record_batch", false]], "datafusion.substrait": [[13, "module-datafusion.substrait", false]], "datafusion.udf": [[14, "module-datafusion.udf", false]], "date_bin() (in module datafusion.functions)": [[4, "datafusion.functions.date_bin", false]], "date_part() (in module datafusion.functions)": [[4, "datafusion.functions.date_part", false]], "date_trunc() (in module datafusion.functions)": [[4, "datafusion.functions.date_trunc", false]], "datepart() (in module datafusion.functions)": [[4, "datafusion.functions.datepart", false]], "datetrunc() (in module datafusion.functions)": [[4, "datafusion.functions.datetrunc", false]], "db (datafusion.catalog.database attribute)": [[0, "datafusion.catalog.Database.db", false]], "db (datafusion.database attribute)": [[5, "datafusion.Database.db", false]], "decode() (in module datafusion.functions)": [[4, "datafusion.functions.decode", false]], "degrees() (in module datafusion.functions)": [[4, "datafusion.functions.degrees", false]], "dense_rank() (in module datafusion.functions)": [[4, "datafusion.functions.dense_rank", false]], "deregister_table() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.deregister_table", false]], "describe() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.describe", false]], "deserialize() (datafusion.substrait.serde static method)": [[13, "datafusion.substrait.Serde.deserialize", false]], "deserialize_bytes() (datafusion.substrait.serde static method)": [[13, "datafusion.substrait.Serde.deserialize_bytes", false]], "df (datafusion.dataframe.dataframe attribute)": [[2, "datafusion.dataframe.DataFrame.df", false]], "dfschema (in module datafusion)": [[5, "datafusion.DFSchema", false]], "digest() (in module datafusion.functions)": [[4, "datafusion.functions.digest", false]], "display() (datafusion.executionplan method)": [[5, "datafusion.ExecutionPlan.display", false]], "display() (datafusion.logicalplan method)": [[5, "datafusion.LogicalPlan.display", false]], "display() (datafusion.plan.executionplan method)": [[11, "datafusion.plan.ExecutionPlan.display", false]], "display() (datafusion.plan.logicalplan method)": [[11, "datafusion.plan.LogicalPlan.display", false]], "display_graphviz() (datafusion.logicalplan method)": [[5, "datafusion.LogicalPlan.display_graphviz", false]], "display_graphviz() (datafusion.plan.logicalplan method)": [[11, "datafusion.plan.LogicalPlan.display_graphviz", false]], "display_indent() (datafusion.executionplan method)": [[5, "datafusion.ExecutionPlan.display_indent", false]], "display_indent() (datafusion.logicalplan method)": [[5, "datafusion.LogicalPlan.display_indent", false]], "display_indent() (datafusion.plan.executionplan method)": [[11, "datafusion.plan.ExecutionPlan.display_indent", false]], "display_indent() (datafusion.plan.logicalplan method)": [[11, "datafusion.plan.LogicalPlan.display_indent", false]], "display_indent_schema() (datafusion.logicalplan method)": [[5, "datafusion.LogicalPlan.display_indent_schema", false]], "display_indent_schema() (datafusion.plan.logicalplan method)": [[11, "datafusion.plan.LogicalPlan.display_indent_schema", false]], "display_name() (datafusion.expr method)": [[5, "datafusion.Expr.display_name", false]], "display_name() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.display_name", false]], "distinct (in module datafusion.expr)": [[3, "datafusion.expr.Distinct", false]], "distinct() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.distinct", false]], "distinct() (datafusion.expr method)": [[5, "datafusion.Expr.distinct", false]], "distinct() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.distinct", false]], "drop() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.drop", false]], "droptable (in module datafusion.expr)": [[3, "datafusion.expr.DropTable", false]], "empty() (in module datafusion.functions)": [[4, "datafusion.functions.empty", false]], "empty_table() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.empty_table", false]], "emptyrelation (in module datafusion.expr)": [[3, "datafusion.expr.EmptyRelation", false]], "enable_url_table() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.enable_url_table", false]], "encode() (datafusion.substrait.plan method)": [[13, "datafusion.substrait.Plan.encode", false]], "encode() (in module datafusion.functions)": [[4, "datafusion.functions.encode", false]], "end() (datafusion.expr.casebuilder method)": [[3, "datafusion.expr.CaseBuilder.end", false]], "ends_with() (in module datafusion.functions)": [[4, "datafusion.functions.ends_with", false]], "evaluate() (datafusion.accumulator method)": [[5, "datafusion.Accumulator.evaluate", false]], "evaluate() (datafusion.udf.accumulator method)": [[14, "datafusion.udf.Accumulator.evaluate", false]], "evaluate() (datafusion.udf.windowevaluator method)": [[14, "datafusion.udf.WindowEvaluator.evaluate", false]], "evaluate_all() (datafusion.udf.windowevaluator method)": [[14, "datafusion.udf.WindowEvaluator.evaluate_all", false]], "evaluate_all_with_rank() (datafusion.udf.windowevaluator method)": [[14, "datafusion.udf.WindowEvaluator.evaluate_all_with_rank", false]], "except_all() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.except_all", false]], "execute() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.execute", false]], "execute_stream() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.execute_stream", false]], "execute_stream_partitioned() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.execute_stream_partitioned", false]], "execution_plan() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.execution_plan", false]], "executionplan (class in datafusion)": [[5, "datafusion.ExecutionPlan", false]], "executionplan (class in datafusion.plan)": [[11, "datafusion.plan.ExecutionPlan", false]], "exists (in module datafusion.expr)": [[3, "datafusion.expr.Exists", false]], "exp() (in module datafusion.functions)": [[4, "datafusion.functions.exp", false]], "explain (in module datafusion.expr)": [[3, "datafusion.expr.Explain", false]], "explain() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.explain", false]], "expr (class in datafusion)": [[5, "datafusion.Expr", false]], "expr (class in datafusion.expr)": [[3, "datafusion.expr.Expr", false]], "expr (datafusion.expr attribute)": [[5, "datafusion.Expr.expr", false]], "expr (datafusion.expr.expr attribute)": [[3, "datafusion.expr.Expr.expr", false]], "expr() (datafusion.expr.sortexpr method)": [[3, "datafusion.expr.SortExpr.expr", false]], "extension (in module datafusion.expr)": [[3, "datafusion.expr.Extension", false]], "extract() (in module datafusion.functions)": [[4, "datafusion.functions.extract", false]], "factorial() (in module datafusion.functions)": [[4, "datafusion.functions.factorial", false]], "fill_nan() (datafusion.expr method)": [[5, "datafusion.Expr.fill_nan", false]], "fill_nan() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.fill_nan", false]], "fill_null() (datafusion.expr method)": [[5, "datafusion.Expr.fill_null", false]], "fill_null() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.fill_null", false]], "filter (in module datafusion.expr)": [[3, "datafusion.expr.Filter", false]], "filter() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.filter", false]], "filter() (datafusion.expr method)": [[5, "datafusion.Expr.filter", false]], "filter() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.filter", false]], "find_in_set() (in module datafusion.functions)": [[4, "datafusion.functions.find_in_set", false]], "first_value() (in module datafusion.functions)": [[4, "datafusion.functions.first_value", false]], "flatten() (in module datafusion.functions)": [[4, "datafusion.functions.flatten", false]], "floor() (in module datafusion.functions)": [[4, "datafusion.functions.floor", false]], "frame_bound (datafusion.expr.windowframebound attribute)": [[3, "datafusion.expr.WindowFrameBound.frame_bound", false]], "from_arrow() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.from_arrow", false]], "from_arrow_table() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.from_arrow_table", false]], "from_pandas() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.from_pandas", false]], "from_polars() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.from_polars", false]], "from_proto() (datafusion.executionplan static method)": [[5, "datafusion.ExecutionPlan.from_proto", false]], "from_proto() (datafusion.logicalplan static method)": [[5, "datafusion.LogicalPlan.from_proto", false]], "from_proto() (datafusion.plan.executionplan static method)": [[11, "datafusion.plan.ExecutionPlan.from_proto", false]], "from_proto() (datafusion.plan.logicalplan static method)": [[11, "datafusion.plan.LogicalPlan.from_proto", false]], "from_pydict() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.from_pydict", false]], "from_pylist() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.from_pylist", false]], "from_str() (datafusion.dataframe.compression class method)": [[2, "datafusion.dataframe.Compression.from_str", false]], "from_substrait_plan() (datafusion.substrait.consumer static method)": [[13, "datafusion.substrait.Consumer.from_substrait_plan", false]], "from_unixtime() (in module datafusion.functions)": [[4, "datafusion.functions.from_unixtime", false]], "gcd() (in module datafusion.functions)": [[4, "datafusion.functions.gcd", false]], "get_default_level() (datafusion.dataframe.compression method)": [[2, "datafusion.dataframe.Compression.get_default_level", false]], "get_frame_units() (datafusion.expr.windowframe method)": [[3, "datafusion.expr.WindowFrame.get_frame_units", false]], "get_frame_units() (datafusion.windowframe method)": [[5, "datafusion.WindowFrame.get_frame_units", false]], "get_lower_bound() (datafusion.expr.windowframe method)": [[3, "datafusion.expr.WindowFrame.get_lower_bound", false]], "get_lower_bound() (datafusion.windowframe method)": [[5, "datafusion.WindowFrame.get_lower_bound", false]], "get_offset() (datafusion.expr.windowframebound method)": [[3, "datafusion.expr.WindowFrameBound.get_offset", false]], "get_range() (datafusion.udf.windowevaluator method)": [[14, "datafusion.udf.WindowEvaluator.get_range", false]], "get_upper_bound() (datafusion.expr.windowframe method)": [[3, "datafusion.expr.WindowFrame.get_upper_bound", false]], "get_upper_bound() (datafusion.windowframe method)": [[5, "datafusion.WindowFrame.get_upper_bound", false]], "global_ctx() (datafusion.context.sessioncontext class method)": [[1, "datafusion.context.SessionContext.global_ctx", false]], "googlecloud (in module datafusion.object_store)": [[10, "datafusion.object_store.GoogleCloud", false]], "groupingset (in module datafusion.expr)": [[3, "datafusion.expr.GroupingSet", false]], "gzip (datafusion.dataframe.compression attribute)": [[2, "datafusion.dataframe.Compression.GZIP", false]], "head() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.head", false]], "http (in module datafusion.object_store)": [[10, "datafusion.object_store.Http", false]], "ilike (in module datafusion.expr)": [[3, "datafusion.expr.ILike", false]], "immutable (datafusion.udf.volatility attribute)": [[14, "datafusion.udf.Volatility.Immutable", false]], "in_list() (in module datafusion.functions)": [[4, "datafusion.functions.in_list", false]], "include_rank() (datafusion.udf.windowevaluator method)": [[14, "datafusion.udf.WindowEvaluator.include_rank", false]], "initcap() (in module datafusion.functions)": [[4, "datafusion.functions.initcap", false]], "inlist (in module datafusion.expr)": [[3, "datafusion.expr.InList", false]], "inputs() (datafusion.logicalplan method)": [[5, "datafusion.LogicalPlan.inputs", false]], "inputs() (datafusion.plan.logicalplan method)": [[11, "datafusion.plan.LogicalPlan.inputs", false]], "insubquery (in module datafusion.expr)": [[3, "datafusion.expr.InSubquery", false]], "intersect() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.intersect", false]], "into_view() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.into_view", false]], "is_causal() (datafusion.udf.windowevaluator method)": [[14, "datafusion.udf.WindowEvaluator.is_causal", false]], "is_correct_input() (datafusion.input.base.baseinputsource method)": [[6, "datafusion.input.base.BaseInputSource.is_correct_input", false]], "is_correct_input() (datafusion.input.location.locationinputplugin method)": [[8, "datafusion.input.location.LocationInputPlugin.is_correct_input", false]], "is_correct_input() (datafusion.input.locationinputplugin method)": [[7, "datafusion.input.LocationInputPlugin.is_correct_input", false]], "is_current_row() (datafusion.expr.windowframebound method)": [[3, "datafusion.expr.WindowFrameBound.is_current_row", false]], "is_following() (datafusion.expr.windowframebound method)": [[3, "datafusion.expr.WindowFrameBound.is_following", false]], "is_not_null() (datafusion.expr method)": [[5, "datafusion.Expr.is_not_null", false]], "is_not_null() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.is_not_null", false]], "is_null() (datafusion.expr method)": [[5, "datafusion.Expr.is_null", false]], "is_null() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.is_null", false]], "is_preceding() (datafusion.expr.windowframebound method)": [[3, "datafusion.expr.WindowFrameBound.is_preceding", false]], "is_unbounded() (datafusion.expr.windowframebound method)": [[3, "datafusion.expr.WindowFrameBound.is_unbounded", false]], "isfalse (in module datafusion.expr)": [[3, "datafusion.expr.IsFalse", false]], "isnan() (in module datafusion.functions)": [[4, "datafusion.functions.isnan", false]], "isnotfalse (in module datafusion.expr)": [[3, "datafusion.expr.IsNotFalse", false]], "isnotnull (in module datafusion.expr)": [[3, "datafusion.expr.IsNotNull", false]], "isnottrue (in module datafusion.expr)": [[3, "datafusion.expr.IsNotTrue", false]], "isnotunknown (in module datafusion.expr)": [[3, "datafusion.expr.IsNotUnknown", false]], "isnull (in module datafusion.expr)": [[3, "datafusion.expr.IsNull", false]], "istrue (in module datafusion.expr)": [[3, "datafusion.expr.IsTrue", false]], "isunknown (in module datafusion.expr)": [[3, "datafusion.expr.IsUnknown", false]], "iszero() (in module datafusion.functions)": [[4, "datafusion.functions.iszero", false]], "join (in module datafusion.expr)": [[3, "datafusion.expr.Join", false]], "join() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.join", false]], "join_on() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.join_on", false]], "joinconstraint (in module datafusion.expr)": [[3, "datafusion.expr.JoinConstraint", false]], "jointype (in module datafusion.expr)": [[3, "datafusion.expr.JoinType", false]], "kind (datafusion.catalog.table property)": [[0, "datafusion.catalog.Table.kind", false]], "kind (datafusion.table property)": [[5, "datafusion.Table.kind", false]], "lag() (in module datafusion.functions)": [[4, "datafusion.functions.lag", false]], "last_value() (in module datafusion.functions)": [[4, "datafusion.functions.last_value", false]], "lcm() (in module datafusion.functions)": [[4, "datafusion.functions.lcm", false]], "lead() (in module datafusion.functions)": [[4, "datafusion.functions.lead", false]], "left() (in module datafusion.functions)": [[4, "datafusion.functions.left", false]], "length() (in module datafusion.functions)": [[4, "datafusion.functions.length", false]], "levenshtein() (in module datafusion.functions)": [[4, "datafusion.functions.levenshtein", false]], "like (in module datafusion.expr)": [[3, "datafusion.expr.Like", false]], "limit (in module datafusion.expr)": [[3, "datafusion.expr.Limit", false]], "limit() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.limit", false]], "list_append() (in module datafusion.functions)": [[4, "datafusion.functions.list_append", false]], "list_cat() (in module datafusion.functions)": [[4, "datafusion.functions.list_cat", false]], "list_concat() (in module datafusion.functions)": [[4, "datafusion.functions.list_concat", false]], "list_dims() (in module datafusion.functions)": [[4, "datafusion.functions.list_dims", false]], "list_distinct() (in module datafusion.functions)": [[4, "datafusion.functions.list_distinct", false]], "list_element() (in module datafusion.functions)": [[4, "datafusion.functions.list_element", false]], "list_except() (in module datafusion.functions)": [[4, "datafusion.functions.list_except", false]], "list_extract() (in module datafusion.functions)": [[4, "datafusion.functions.list_extract", false]], "list_indexof() (in module datafusion.functions)": [[4, "datafusion.functions.list_indexof", false]], "list_intersect() (in module datafusion.functions)": [[4, "datafusion.functions.list_intersect", false]], "list_join() (in module datafusion.functions)": [[4, "datafusion.functions.list_join", false]], "list_length() (in module datafusion.functions)": [[4, "datafusion.functions.list_length", false]], "list_ndims() (in module datafusion.functions)": [[4, "datafusion.functions.list_ndims", false]], "list_position() (in module datafusion.functions)": [[4, "datafusion.functions.list_position", false]], "list_positions() (in module datafusion.functions)": [[4, "datafusion.functions.list_positions", false]], "list_prepend() (in module datafusion.functions)": [[4, "datafusion.functions.list_prepend", false]], "list_push_back() (in module datafusion.functions)": [[4, "datafusion.functions.list_push_back", false]], "list_push_front() (in module datafusion.functions)": [[4, "datafusion.functions.list_push_front", false]], "list_remove() (in module datafusion.functions)": [[4, "datafusion.functions.list_remove", false]], "list_remove_all() (in module datafusion.functions)": [[4, "datafusion.functions.list_remove_all", false]], "list_remove_n() (in module datafusion.functions)": [[4, "datafusion.functions.list_remove_n", false]], "list_repeat() (in module datafusion.functions)": [[4, "datafusion.functions.list_repeat", false]], "list_replace() (in module datafusion.functions)": [[4, "datafusion.functions.list_replace", false]], "list_replace_all() (in module datafusion.functions)": [[4, "datafusion.functions.list_replace_all", false]], "list_replace_n() (in module datafusion.functions)": [[4, "datafusion.functions.list_replace_n", false]], "list_resize() (in module datafusion.functions)": [[4, "datafusion.functions.list_resize", false]], "list_slice() (in module datafusion.functions)": [[4, "datafusion.functions.list_slice", false]], "list_sort() (in module datafusion.functions)": [[4, "datafusion.functions.list_sort", false]], "list_to_string() (in module datafusion.functions)": [[4, "datafusion.functions.list_to_string", false]], "list_union() (in module datafusion.functions)": [[4, "datafusion.functions.list_union", false]], "lit() (in module datafusion)": [[5, "datafusion.lit", false]], "literal (in module datafusion.expr)": [[3, "datafusion.expr.Literal", false]], "literal() (datafusion.expr static method)": [[5, "datafusion.Expr.literal", false]], "literal() (datafusion.expr.expr static method)": [[3, "datafusion.expr.Expr.literal", false]], "literal() (in module datafusion)": [[5, "datafusion.literal", false]], "ln() (in module datafusion.functions)": [[4, "datafusion.functions.ln", false]], "localfilesystem (in module datafusion.object_store)": [[10, "datafusion.object_store.LocalFileSystem", false]], "locationinputplugin (class in datafusion.input)": [[7, "datafusion.input.LocationInputPlugin", false]], "locationinputplugin (class in datafusion.input.location)": [[8, "datafusion.input.location.LocationInputPlugin", false]], "log() (in module datafusion.functions)": [[4, "datafusion.functions.log", false]], "log10() (in module datafusion.functions)": [[4, "datafusion.functions.log10", false]], "log2() (in module datafusion.functions)": [[4, "datafusion.functions.log2", false]], "logical_plan() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.logical_plan", false]], "logicalplan (class in datafusion)": [[5, "datafusion.LogicalPlan", false]], "logicalplan (class in datafusion.plan)": [[11, "datafusion.plan.LogicalPlan", false]], "lower() (in module datafusion.functions)": [[4, "datafusion.functions.lower", false]], "lpad() (in module datafusion.functions)": [[4, "datafusion.functions.lpad", false]], "ltrim() (in module datafusion.functions)": [[4, "datafusion.functions.ltrim", false]], "lz4 (datafusion.dataframe.compression attribute)": [[2, "datafusion.dataframe.Compression.LZ4", false]], "lz4_raw (datafusion.dataframe.compression attribute)": [[2, "datafusion.dataframe.Compression.LZ4_RAW", false]], "make_array() (in module datafusion.functions)": [[4, "datafusion.functions.make_array", false]], "make_date() (in module datafusion.functions)": [[4, "datafusion.functions.make_date", false]], "make_list() (in module datafusion.functions)": [[4, "datafusion.functions.make_list", false]], "max() (in module datafusion.functions)": [[4, "datafusion.functions.max", false]], "md5() (in module datafusion.functions)": [[4, "datafusion.functions.md5", false]], "mean() (in module datafusion.functions)": [[4, "datafusion.functions.mean", false]], "median() (in module datafusion.functions)": [[4, "datafusion.functions.median", false]], "memoize() (datafusion.udf.windowevaluator method)": [[14, "datafusion.udf.WindowEvaluator.memoize", false]], "merge() (datafusion.accumulator method)": [[5, "datafusion.Accumulator.merge", false]], "merge() (datafusion.udf.accumulator method)": [[14, "datafusion.udf.Accumulator.merge", false]], "microsoftazure (in module datafusion.object_store)": [[10, "datafusion.object_store.MicrosoftAzure", false]], "min() (in module datafusion.functions)": [[4, "datafusion.functions.min", false]], "module": [[0, "module-datafusion.catalog", false], [1, "module-datafusion.context", false], [2, "module-datafusion.dataframe", false], [3, "module-datafusion.expr", false], [4, "module-datafusion.functions", false], [5, "module-datafusion", false], [6, "module-datafusion.input.base", false], [7, "module-datafusion.input", false], [8, "module-datafusion.input.location", false], [9, "module-datafusion.io", false], [10, "module-datafusion.object_store", false], [11, "module-datafusion.plan", false], [12, "module-datafusion.record_batch", false], [13, "module-datafusion.substrait", false], [14, "module-datafusion.udf", false]], "named_struct() (in module datafusion.functions)": [[4, "datafusion.functions.named_struct", false]], "names() (datafusion.catalog method)": [[5, "datafusion.Catalog.names", false]], "names() (datafusion.catalog.catalog method)": [[0, "datafusion.catalog.Catalog.names", false]], "names() (datafusion.catalog.database method)": [[0, "datafusion.catalog.Database.names", false]], "names() (datafusion.database method)": [[5, "datafusion.Database.names", false]], "nanvl() (in module datafusion.functions)": [[4, "datafusion.functions.nanvl", false]], "negative (in module datafusion.expr)": [[3, "datafusion.expr.Negative", false]], "next() (datafusion.record_batch.recordbatchstream method)": [[12, "datafusion.record_batch.RecordBatchStream.next", false]], "next() (datafusion.recordbatchstream method)": [[5, "datafusion.RecordBatchStream.next", false]], "not (in module datafusion.expr)": [[3, "datafusion.expr.Not", false]], "now() (in module datafusion.functions)": [[4, "datafusion.functions.now", false]], "nth_value() (in module datafusion.functions)": [[4, "datafusion.functions.nth_value", false]], "ntile() (in module datafusion.functions)": [[4, "datafusion.functions.ntile", false]], "null_treatment() (datafusion.expr method)": [[5, "datafusion.Expr.null_treatment", false]], "null_treatment() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.null_treatment", false]], "nullif() (in module datafusion.functions)": [[4, "datafusion.functions.nullif", false]], "nulls_first() (datafusion.expr.sortexpr method)": [[3, "datafusion.expr.SortExpr.nulls_first", false]], "nvl() (in module datafusion.functions)": [[4, "datafusion.functions.nvl", false]], "octet_length() (in module datafusion.functions)": [[4, "datafusion.functions.octet_length", false]], "optimized_logical_plan() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.optimized_logical_plan", false]], "options_internal (datafusion.context.sqloptions attribute)": [[1, "datafusion.context.SQLOptions.options_internal", false]], "options_internal (datafusion.sqloptions attribute)": [[5, "datafusion.SQLOptions.options_internal", false]], "order_by() (datafusion.expr method)": [[5, "datafusion.Expr.order_by", false]], "order_by() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.order_by", false]], "order_by() (in module datafusion.functions)": [[4, "datafusion.functions.order_by", false]], "otherwise() (datafusion.expr.casebuilder method)": [[3, "datafusion.expr.CaseBuilder.otherwise", false]], "over() (datafusion.expr method)": [[5, "datafusion.Expr.over", false]], "over() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.over", false]], "overlay() (in module datafusion.functions)": [[4, "datafusion.functions.overlay", false]], "partition_by() (datafusion.expr method)": [[5, "datafusion.Expr.partition_by", false]], "partition_by() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.partition_by", false]], "partition_count (datafusion.executionplan property)": [[5, "datafusion.ExecutionPlan.partition_count", false]], "partition_count (datafusion.plan.executionplan property)": [[11, "datafusion.plan.ExecutionPlan.partition_count", false]], "partitioning (in module datafusion.expr)": [[3, "datafusion.expr.Partitioning", false]], "percent_rank() (in module datafusion.functions)": [[4, "datafusion.functions.percent_rank", false]], "pi() (in module datafusion.functions)": [[4, "datafusion.functions.pi", false]], "placeholder (in module datafusion.expr)": [[3, "datafusion.expr.Placeholder", false]], "plan (class in datafusion.substrait)": [[13, "datafusion.substrait.Plan", false]], "plan_internal (datafusion.substrait.plan attribute)": [[13, "datafusion.substrait.Plan.plan_internal", false]], "pow() (in module datafusion.functions)": [[4, "datafusion.functions.pow", false]], "power() (in module datafusion.functions)": [[4, "datafusion.functions.power", false]], "producer (class in datafusion.substrait)": [[13, "datafusion.substrait.Producer", false]], "projection (in module datafusion.expr)": [[3, "datafusion.expr.Projection", false]], "python_value() (datafusion.expr method)": [[5, "datafusion.Expr.python_value", false]], "python_value() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.python_value", false]], "radians() (in module datafusion.functions)": [[4, "datafusion.functions.radians", false]], "random() (in module datafusion.functions)": [[4, "datafusion.functions.random", false]], "range() (in module datafusion.functions)": [[4, "datafusion.functions.range", false]], "rank() (in module datafusion.functions)": [[4, "datafusion.functions.rank", false]], "raw_sort (datafusion.expr.sortexpr attribute)": [[3, "datafusion.expr.SortExpr.raw_sort", false]], "rbs (datafusion.record_batch.recordbatchstream attribute)": [[12, "datafusion.record_batch.RecordBatchStream.rbs", false]], "rbs (datafusion.recordbatchstream attribute)": [[5, "datafusion.RecordBatchStream.rbs", false]], "read_avro() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.read_avro", false]], "read_avro() (in module datafusion)": [[5, "datafusion.read_avro", false]], "read_avro() (in module datafusion.io)": [[9, "datafusion.io.read_avro", false]], "read_csv() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.read_csv", false]], "read_csv() (in module datafusion)": [[5, "datafusion.read_csv", false]], "read_csv() (in module datafusion.io)": [[9, "datafusion.io.read_csv", false]], "read_json() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.read_json", false]], "read_json() (in module datafusion)": [[5, "datafusion.read_json", false]], "read_json() (in module datafusion.io)": [[9, "datafusion.io.read_json", false]], "read_parquet() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.read_parquet", false]], "read_parquet() (in module datafusion)": [[5, "datafusion.read_parquet", false]], "read_parquet() (in module datafusion.io)": [[9, "datafusion.io.read_parquet", false]], "read_table() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.read_table", false]], "record_batch (datafusion.record_batch.recordbatch attribute)": [[12, "datafusion.record_batch.RecordBatch.record_batch", false]], "record_batch (datafusion.recordbatch attribute)": [[5, "datafusion.RecordBatch.record_batch", false]], "recordbatch (class in datafusion)": [[5, "datafusion.RecordBatch", false]], "recordbatch (class in datafusion.record_batch)": [[12, "datafusion.record_batch.RecordBatch", false]], "recordbatchstream (class in datafusion)": [[5, "datafusion.RecordBatchStream", false]], "recordbatchstream (class in datafusion.record_batch)": [[12, "datafusion.record_batch.RecordBatchStream", false]], "regexp_count() (in module datafusion.functions)": [[4, "datafusion.functions.regexp_count", false]], "regexp_like() (in module datafusion.functions)": [[4, "datafusion.functions.regexp_like", false]], "regexp_match() (in module datafusion.functions)": [[4, "datafusion.functions.regexp_match", false]], "regexp_replace() (in module datafusion.functions)": [[4, "datafusion.functions.regexp_replace", false]], "register_avro() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.register_avro", false]], "register_csv() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.register_csv", false]], "register_dataset() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.register_dataset", false]], "register_json() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.register_json", false]], "register_listing_table() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.register_listing_table", false]], "register_object_store() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.register_object_store", false]], "register_parquet() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.register_parquet", false]], "register_record_batches() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.register_record_batches", false]], "register_table() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.register_table", false]], "register_table_provider() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.register_table_provider", false]], "register_udaf() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.register_udaf", false]], "register_udf() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.register_udf", false]], "register_udwf() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.register_udwf", false]], "register_view() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.register_view", false]], "regr_avgx() (in module datafusion.functions)": [[4, "datafusion.functions.regr_avgx", false]], "regr_avgy() (in module datafusion.functions)": [[4, "datafusion.functions.regr_avgy", false]], "regr_count() (in module datafusion.functions)": [[4, "datafusion.functions.regr_count", false]], "regr_intercept() (in module datafusion.functions)": [[4, "datafusion.functions.regr_intercept", false]], "regr_r2() (in module datafusion.functions)": [[4, "datafusion.functions.regr_r2", false]], "regr_slope() (in module datafusion.functions)": [[4, "datafusion.functions.regr_slope", false]], "regr_sxx() (in module datafusion.functions)": [[4, "datafusion.functions.regr_sxx", false]], "regr_sxy() (in module datafusion.functions)": [[4, "datafusion.functions.regr_sxy", false]], "regr_syy() (in module datafusion.functions)": [[4, "datafusion.functions.regr_syy", false]], "repartition (in module datafusion.expr)": [[3, "datafusion.expr.Repartition", false]], "repartition() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.repartition", false]], "repartition_by_hash() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.repartition_by_hash", false]], "repeat() (in module datafusion.functions)": [[4, "datafusion.functions.repeat", false]], "replace() (in module datafusion.functions)": [[4, "datafusion.functions.replace", false]], "reverse() (in module datafusion.functions)": [[4, "datafusion.functions.reverse", false]], "rex_call_operands() (datafusion.expr method)": [[5, "datafusion.Expr.rex_call_operands", false]], "rex_call_operands() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.rex_call_operands", false]], "rex_call_operator() (datafusion.expr method)": [[5, "datafusion.Expr.rex_call_operator", false]], "rex_call_operator() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.rex_call_operator", false]], "rex_type() (datafusion.expr method)": [[5, "datafusion.Expr.rex_type", false]], "rex_type() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.rex_type", false]], "right() (in module datafusion.functions)": [[4, "datafusion.functions.right", false]], "round() (in module datafusion.functions)": [[4, "datafusion.functions.round", false]], "row_number() (in module datafusion.functions)": [[4, "datafusion.functions.row_number", false]], "rpad() (in module datafusion.functions)": [[4, "datafusion.functions.rpad", false]], "rtrim() (in module datafusion.functions)": [[4, "datafusion.functions.rtrim", false]], "runtimeconfig (class in datafusion.context)": [[1, "datafusion.context.RuntimeConfig", false]], "runtimeenvbuilder (class in datafusion)": [[5, "datafusion.RuntimeEnvBuilder", false]], "runtimeenvbuilder (class in datafusion.context)": [[1, "datafusion.context.RuntimeEnvBuilder", false]], "scalarsubquery (in module datafusion.expr)": [[3, "datafusion.expr.ScalarSubquery", false]], "scalarudf (class in datafusion)": [[5, "datafusion.ScalarUDF", false]], "scalarudf (class in datafusion.udf)": [[14, "datafusion.udf.ScalarUDF", false]], "scalarvariable (in module datafusion.expr)": [[3, "datafusion.expr.ScalarVariable", false]], "schema (datafusion.catalog.table property)": [[0, "datafusion.catalog.Table.schema", false]], "schema (datafusion.table property)": [[5, "datafusion.Table.schema", false]], "schema() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.schema", false]], "schema_name() (datafusion.expr method)": [[5, "datafusion.Expr.schema_name", false]], "schema_name() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.schema_name", false]], "select() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.select", false]], "select_columns() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.select_columns", false]], "serde (class in datafusion.substrait)": [[13, "datafusion.substrait.Serde", false]], "serialize() (datafusion.substrait.serde static method)": [[13, "datafusion.substrait.Serde.serialize", false]], "serialize_bytes() (datafusion.substrait.serde static method)": [[13, "datafusion.substrait.Serde.serialize_bytes", false]], "serialize_to_plan() (datafusion.substrait.serde static method)": [[13, "datafusion.substrait.Serde.serialize_to_plan", false]], "session_id() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.session_id", false]], "sessionconfig (class in datafusion)": [[5, "datafusion.SessionConfig", false]], "sessionconfig (class in datafusion.context)": [[1, "datafusion.context.SessionConfig", false]], "sessioncontext (class in datafusion.context)": [[1, "datafusion.context.SessionContext", false]], "set() (datafusion.context.sessionconfig method)": [[1, "datafusion.context.SessionConfig.set", false]], "set() (datafusion.sessionconfig method)": [[5, "datafusion.SessionConfig.set", false]], "sha224() (in module datafusion.functions)": [[4, "datafusion.functions.sha224", false]], "sha256() (in module datafusion.functions)": [[4, "datafusion.functions.sha256", false]], "sha384() (in module datafusion.functions)": [[4, "datafusion.functions.sha384", false]], "sha512() (in module datafusion.functions)": [[4, "datafusion.functions.sha512", false]], "show() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.show", false]], "signum() (in module datafusion.functions)": [[4, "datafusion.functions.signum", false]], "similarto (in module datafusion.expr)": [[3, "datafusion.expr.SimilarTo", false]], "sin() (in module datafusion.functions)": [[4, "datafusion.functions.sin", false]], "sinh() (in module datafusion.functions)": [[4, "datafusion.functions.sinh", false]], "snappy (datafusion.dataframe.compression attribute)": [[2, "datafusion.dataframe.Compression.SNAPPY", false]], "sort (in module datafusion.expr)": [[3, "datafusion.expr.Sort", false]], "sort() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.sort", false]], "sort() (datafusion.expr method)": [[5, "datafusion.Expr.sort", false]], "sort() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.sort", false]], "sortexpr (class in datafusion.expr)": [[3, "datafusion.expr.SortExpr", false]], "split_part() (in module datafusion.functions)": [[4, "datafusion.functions.split_part", false]], "sql() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.sql", false]], "sql_with_options() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.sql_with_options", false]], "sqloptions (class in datafusion)": [[5, "datafusion.SQLOptions", false]], "sqloptions (class in datafusion.context)": [[1, "datafusion.context.SQLOptions", false]], "sqrt() (in module datafusion.functions)": [[4, "datafusion.functions.sqrt", false]], "stable (datafusion.udf.volatility attribute)": [[14, "datafusion.udf.Volatility.Stable", false]], "starts_with() (in module datafusion.functions)": [[4, "datafusion.functions.starts_with", false]], "state() (datafusion.accumulator method)": [[5, "datafusion.Accumulator.state", false]], "state() (datafusion.udf.accumulator method)": [[14, "datafusion.udf.Accumulator.state", false]], "stddev() (in module datafusion.functions)": [[4, "datafusion.functions.stddev", false]], "stddev_pop() (in module datafusion.functions)": [[4, "datafusion.functions.stddev_pop", false]], "stddev_samp() (in module datafusion.functions)": [[4, "datafusion.functions.stddev_samp", false]], "string_agg() (in module datafusion.functions)": [[4, "datafusion.functions.string_agg", false]], "string_literal() (datafusion.expr static method)": [[5, "datafusion.Expr.string_literal", false]], "string_literal() (datafusion.expr.expr static method)": [[3, "datafusion.expr.Expr.string_literal", false]], "strpos() (in module datafusion.functions)": [[4, "datafusion.functions.strpos", false]], "struct() (in module datafusion.functions)": [[4, "datafusion.functions.struct", false]], "subquery (in module datafusion.expr)": [[3, "datafusion.expr.Subquery", false]], "subqueryalias (in module datafusion.expr)": [[3, "datafusion.expr.SubqueryAlias", false]], "substr() (in module datafusion.functions)": [[4, "datafusion.functions.substr", false]], "substr_index() (in module datafusion.functions)": [[4, "datafusion.functions.substr_index", false]], "substring() (in module datafusion.functions)": [[4, "datafusion.functions.substring", false]], "sum() (in module datafusion.functions)": [[4, "datafusion.functions.sum", false]], "supports_bounded_execution() (datafusion.udf.windowevaluator method)": [[14, "datafusion.udf.WindowEvaluator.supports_bounded_execution", false]], "table (class in datafusion)": [[5, "datafusion.Table", false]], "table (class in datafusion.catalog)": [[0, "datafusion.catalog.Table", false]], "table (datafusion.catalog.table attribute)": [[0, "datafusion.catalog.Table.table", false]], "table (datafusion.table attribute)": [[5, "datafusion.Table.table", false]], "table() (datafusion.catalog.database method)": [[0, "datafusion.catalog.Database.table", false]], "table() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.table", false]], "table() (datafusion.database method)": [[5, "datafusion.Database.table", false]], "table_exist() (datafusion.context.sessioncontext method)": [[1, "datafusion.context.SessionContext.table_exist", false]], "tableproviderexportable (class in datafusion.context)": [[1, "datafusion.context.TableProviderExportable", false]], "tablescan (in module datafusion.expr)": [[3, "datafusion.expr.TableScan", false]], "tail() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.tail", false]], "tan() (in module datafusion.functions)": [[4, "datafusion.functions.tan", false]], "tanh() (in module datafusion.functions)": [[4, "datafusion.functions.tanh", false]], "to_arrow_table() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.to_arrow_table", false]], "to_hex() (in module datafusion.functions)": [[4, "datafusion.functions.to_hex", false]], "to_pandas() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.to_pandas", false]], "to_polars() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.to_polars", false]], "to_proto() (datafusion.executionplan method)": [[5, "datafusion.ExecutionPlan.to_proto", false]], "to_proto() (datafusion.logicalplan method)": [[5, "datafusion.LogicalPlan.to_proto", false]], "to_proto() (datafusion.plan.executionplan method)": [[11, "datafusion.plan.ExecutionPlan.to_proto", false]], "to_proto() (datafusion.plan.logicalplan method)": [[11, "datafusion.plan.LogicalPlan.to_proto", false]], "to_pyarrow() (datafusion.record_batch.recordbatch method)": [[12, "datafusion.record_batch.RecordBatch.to_pyarrow", false]], "to_pyarrow() (datafusion.recordbatch method)": [[5, "datafusion.RecordBatch.to_pyarrow", false]], "to_pydict() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.to_pydict", false]], "to_pylist() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.to_pylist", false]], "to_substrait_plan() (datafusion.substrait.producer static method)": [[13, "datafusion.substrait.Producer.to_substrait_plan", false]], "to_timestamp() (in module datafusion.functions)": [[4, "datafusion.functions.to_timestamp", false]], "to_timestamp_micros() (in module datafusion.functions)": [[4, "datafusion.functions.to_timestamp_micros", false]], "to_timestamp_millis() (in module datafusion.functions)": [[4, "datafusion.functions.to_timestamp_millis", false]], "to_timestamp_nanos() (in module datafusion.functions)": [[4, "datafusion.functions.to_timestamp_nanos", false]], "to_timestamp_seconds() (in module datafusion.functions)": [[4, "datafusion.functions.to_timestamp_seconds", false]], "to_unixtime() (in module datafusion.functions)": [[4, "datafusion.functions.to_unixtime", false]], "to_variant() (datafusion.expr method)": [[5, "datafusion.Expr.to_variant", false]], "to_variant() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.to_variant", false]], "to_variant() (datafusion.logicalplan method)": [[5, "datafusion.LogicalPlan.to_variant", false]], "to_variant() (datafusion.plan.logicalplan method)": [[11, "datafusion.plan.LogicalPlan.to_variant", false]], "transform() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.transform", false]], "translate() (in module datafusion.functions)": [[4, "datafusion.functions.translate", false]], "trim() (in module datafusion.functions)": [[4, "datafusion.functions.trim", false]], "trunc() (in module datafusion.functions)": [[4, "datafusion.functions.trunc", false]], "trycast (in module datafusion.expr)": [[3, "datafusion.expr.TryCast", false]], "types() (datafusion.expr method)": [[5, "datafusion.Expr.types", false]], "types() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.types", false]], "udaf (in module datafusion)": [[5, "datafusion.udaf", false]], "udaf (in module datafusion.udf)": [[14, "datafusion.udf.udaf", false]], "udaf() (datafusion.aggregateudf static method)": [[5, "datafusion.AggregateUDF.udaf", false]], "udaf() (datafusion.udf.aggregateudf static method)": [[14, "datafusion.udf.AggregateUDF.udaf", false]], "udf (in module datafusion)": [[5, "datafusion.udf", false]], "udf (in module datafusion.udf)": [[14, "datafusion.udf.udf", false]], "udf() (datafusion.scalarudf static method)": [[5, "datafusion.ScalarUDF.udf", false]], "udf() (datafusion.udf.scalarudf static method)": [[14, "datafusion.udf.ScalarUDF.udf", false]], "udwf (in module datafusion)": [[5, "datafusion.udwf", false]], "udwf (in module datafusion.udf)": [[14, "datafusion.udf.udwf", false]], "udwf() (datafusion.udf.windowudf static method)": [[14, "datafusion.udf.WindowUDF.udwf", false]], "udwf() (datafusion.windowudf static method)": [[5, "datafusion.WindowUDF.udwf", false]], "uncompressed (datafusion.dataframe.compression attribute)": [[2, "datafusion.dataframe.Compression.UNCOMPRESSED", false]], "union (in module datafusion.expr)": [[3, "datafusion.expr.Union", false]], "union() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.union", false]], "union_distinct() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.union_distinct", false]], "unnest (in module datafusion.expr)": [[3, "datafusion.expr.Unnest", false]], "unnest_columns() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.unnest_columns", false]], "unnestexpr (in module datafusion.expr)": [[3, "datafusion.expr.UnnestExpr", false]], "update() (datafusion.accumulator method)": [[5, "datafusion.Accumulator.update", false]], "update() (datafusion.udf.accumulator method)": [[14, "datafusion.udf.Accumulator.update", false]], "upper() (in module datafusion.functions)": [[4, "datafusion.functions.upper", false]], "uses_window_frame() (datafusion.udf.windowevaluator method)": [[14, "datafusion.udf.WindowEvaluator.uses_window_frame", false]], "uuid() (in module datafusion.functions)": [[4, "datafusion.functions.uuid", false]], "var() (in module datafusion.functions)": [[4, "datafusion.functions.var", false]], "var_pop() (in module datafusion.functions)": [[4, "datafusion.functions.var_pop", false]], "var_samp() (in module datafusion.functions)": [[4, "datafusion.functions.var_samp", false]], "var_sample() (in module datafusion.functions)": [[4, "datafusion.functions.var_sample", false]], "variant_name() (datafusion.expr method)": [[5, "datafusion.Expr.variant_name", false]], "variant_name() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.variant_name", false]], "volatile (datafusion.udf.volatility attribute)": [[14, "datafusion.udf.Volatility.Volatile", false]], "volatility (class in datafusion.udf)": [[14, "datafusion.udf.Volatility", false]], "when() (datafusion.expr.casebuilder method)": [[3, "datafusion.expr.CaseBuilder.when", false]], "when() (in module datafusion.functions)": [[4, "datafusion.functions.when", false]], "window (class in datafusion.expr)": [[3, "datafusion.expr.Window", false]], "window() (in module datafusion.functions)": [[4, "datafusion.functions.window", false]], "window_frame (datafusion.expr.windowframe attribute)": [[3, "datafusion.expr.WindowFrame.window_frame", false]], "window_frame (datafusion.windowframe attribute)": [[5, "datafusion.WindowFrame.window_frame", false]], "window_frame() (datafusion.expr method)": [[5, "datafusion.Expr.window_frame", false]], "window_frame() (datafusion.expr.expr method)": [[3, "datafusion.expr.Expr.window_frame", false]], "windowevaluator (class in datafusion.udf)": [[14, "datafusion.udf.WindowEvaluator", false]], "windowexpr (in module datafusion.expr)": [[3, "datafusion.expr.WindowExpr", false]], "windowframe (class in datafusion)": [[5, "datafusion.WindowFrame", false]], "windowframe (class in datafusion.expr)": [[3, "datafusion.expr.WindowFrame", false]], "windowframebound (class in datafusion.expr)": [[3, "datafusion.expr.WindowFrameBound", false]], "windowudf (class in datafusion)": [[5, "datafusion.WindowUDF", false]], "windowudf (class in datafusion.udf)": [[14, "datafusion.udf.WindowUDF", false]], "with_allow_ddl() (datafusion.context.sqloptions method)": [[1, "datafusion.context.SQLOptions.with_allow_ddl", false]], "with_allow_ddl() (datafusion.sqloptions method)": [[5, "datafusion.SQLOptions.with_allow_ddl", false]], "with_allow_dml() (datafusion.context.sqloptions method)": [[1, "datafusion.context.SQLOptions.with_allow_dml", false]], "with_allow_dml() (datafusion.sqloptions method)": [[5, "datafusion.SQLOptions.with_allow_dml", false]], "with_allow_statements() (datafusion.context.sqloptions method)": [[1, "datafusion.context.SQLOptions.with_allow_statements", false]], "with_allow_statements() (datafusion.sqloptions method)": [[5, "datafusion.SQLOptions.with_allow_statements", false]], "with_batch_size() (datafusion.context.sessionconfig method)": [[1, "datafusion.context.SessionConfig.with_batch_size", false]], "with_batch_size() (datafusion.sessionconfig method)": [[5, "datafusion.SessionConfig.with_batch_size", false]], "with_column() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.with_column", false]], "with_column_renamed() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.with_column_renamed", false]], "with_columns() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.with_columns", false]], "with_create_default_catalog_and_schema() (datafusion.context.sessionconfig method)": [[1, "datafusion.context.SessionConfig.with_create_default_catalog_and_schema", false]], "with_create_default_catalog_and_schema() (datafusion.sessionconfig method)": [[5, "datafusion.SessionConfig.with_create_default_catalog_and_schema", false]], "with_default_catalog_and_schema() (datafusion.context.sessionconfig method)": [[1, "datafusion.context.SessionConfig.with_default_catalog_and_schema", false]], "with_default_catalog_and_schema() (datafusion.sessionconfig method)": [[5, "datafusion.SessionConfig.with_default_catalog_and_schema", false]], "with_disk_manager_disabled() (datafusion.context.runtimeenvbuilder method)": [[1, "datafusion.context.RuntimeEnvBuilder.with_disk_manager_disabled", false]], "with_disk_manager_disabled() (datafusion.runtimeenvbuilder method)": [[5, "datafusion.RuntimeEnvBuilder.with_disk_manager_disabled", false]], "with_disk_manager_os() (datafusion.context.runtimeenvbuilder method)": [[1, "datafusion.context.RuntimeEnvBuilder.with_disk_manager_os", false]], "with_disk_manager_os() (datafusion.runtimeenvbuilder method)": [[5, "datafusion.RuntimeEnvBuilder.with_disk_manager_os", false]], "with_disk_manager_specified() (datafusion.context.runtimeenvbuilder method)": [[1, "datafusion.context.RuntimeEnvBuilder.with_disk_manager_specified", false]], "with_disk_manager_specified() (datafusion.runtimeenvbuilder method)": [[5, "datafusion.RuntimeEnvBuilder.with_disk_manager_specified", false]], "with_fair_spill_pool() (datafusion.context.runtimeenvbuilder method)": [[1, "datafusion.context.RuntimeEnvBuilder.with_fair_spill_pool", false]], "with_fair_spill_pool() (datafusion.runtimeenvbuilder method)": [[5, "datafusion.RuntimeEnvBuilder.with_fair_spill_pool", false]], "with_greedy_memory_pool() (datafusion.context.runtimeenvbuilder method)": [[1, "datafusion.context.RuntimeEnvBuilder.with_greedy_memory_pool", false]], "with_greedy_memory_pool() (datafusion.runtimeenvbuilder method)": [[5, "datafusion.RuntimeEnvBuilder.with_greedy_memory_pool", false]], "with_information_schema() (datafusion.context.sessionconfig method)": [[1, "datafusion.context.SessionConfig.with_information_schema", false]], "with_information_schema() (datafusion.sessionconfig method)": [[5, "datafusion.SessionConfig.with_information_schema", false]], "with_parquet_pruning() (datafusion.context.sessionconfig method)": [[1, "datafusion.context.SessionConfig.with_parquet_pruning", false]], "with_parquet_pruning() (datafusion.sessionconfig method)": [[5, "datafusion.SessionConfig.with_parquet_pruning", false]], "with_repartition_aggregations() (datafusion.context.sessionconfig method)": [[1, "datafusion.context.SessionConfig.with_repartition_aggregations", false]], "with_repartition_aggregations() (datafusion.sessionconfig method)": [[5, "datafusion.SessionConfig.with_repartition_aggregations", false]], "with_repartition_file_min_size() (datafusion.context.sessionconfig method)": [[1, "datafusion.context.SessionConfig.with_repartition_file_min_size", false]], "with_repartition_file_min_size() (datafusion.sessionconfig method)": [[5, "datafusion.SessionConfig.with_repartition_file_min_size", false]], "with_repartition_file_scans() (datafusion.context.sessionconfig method)": [[1, "datafusion.context.SessionConfig.with_repartition_file_scans", false]], "with_repartition_file_scans() (datafusion.sessionconfig method)": [[5, "datafusion.SessionConfig.with_repartition_file_scans", false]], "with_repartition_joins() (datafusion.context.sessionconfig method)": [[1, "datafusion.context.SessionConfig.with_repartition_joins", false]], "with_repartition_joins() (datafusion.sessionconfig method)": [[5, "datafusion.SessionConfig.with_repartition_joins", false]], "with_repartition_sorts() (datafusion.context.sessionconfig method)": [[1, "datafusion.context.SessionConfig.with_repartition_sorts", false]], "with_repartition_sorts() (datafusion.sessionconfig method)": [[5, "datafusion.SessionConfig.with_repartition_sorts", false]], "with_repartition_windows() (datafusion.context.sessionconfig method)": [[1, "datafusion.context.SessionConfig.with_repartition_windows", false]], "with_repartition_windows() (datafusion.sessionconfig method)": [[5, "datafusion.SessionConfig.with_repartition_windows", false]], "with_target_partitions() (datafusion.context.sessionconfig method)": [[1, "datafusion.context.SessionConfig.with_target_partitions", false]], "with_target_partitions() (datafusion.sessionconfig method)": [[5, "datafusion.SessionConfig.with_target_partitions", false]], "with_temp_file_path() (datafusion.context.runtimeenvbuilder method)": [[1, "datafusion.context.RuntimeEnvBuilder.with_temp_file_path", false]], "with_temp_file_path() (datafusion.runtimeenvbuilder method)": [[5, "datafusion.RuntimeEnvBuilder.with_temp_file_path", false]], "with_unbounded_memory_pool() (datafusion.context.runtimeenvbuilder method)": [[1, "datafusion.context.RuntimeEnvBuilder.with_unbounded_memory_pool", false]], "with_unbounded_memory_pool() (datafusion.runtimeenvbuilder method)": [[5, "datafusion.RuntimeEnvBuilder.with_unbounded_memory_pool", false]], "write_csv() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.write_csv", false]], "write_json() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.write_json", false]], "write_parquet() (datafusion.dataframe.dataframe method)": [[2, "datafusion.dataframe.DataFrame.write_parquet", false]], "zstd (datafusion.dataframe.compression attribute)": [[2, "datafusion.dataframe.Compression.ZSTD", false]]}, "objects": {"": [[5, 0, 0, "-", "datafusion"]], "datafusion": [[5, 1, 1, "", "Accumulator"], [5, 1, 1, "", "AggregateUDF"], [5, 1, 1, "", "Catalog"], [5, 4, 1, "", "DFSchema"], [5, 1, 1, "", "Database"], [5, 1, 1, "", "ExecutionPlan"], [5, 1, 1, "", "Expr"], [5, 1, 1, "", "LogicalPlan"], [5, 1, 1, "", "RecordBatch"], [5, 1, 1, "", "RecordBatchStream"], [5, 1, 1, "", "RuntimeEnvBuilder"], [5, 1, 1, "", "SQLOptions"], [5, 1, 1, "", "ScalarUDF"], [5, 1, 1, "", "SessionConfig"], [5, 1, 1, "", "Table"], [5, 1, 1, "", "WindowFrame"], [5, 1, 1, "", "WindowUDF"], [0, 0, 0, "-", "catalog"], [5, 6, 1, "", "col"], [5, 6, 1, "", "column"], [1, 0, 0, "-", "context"], [2, 0, 0, "-", "dataframe"], [3, 0, 0, "-", "expr"], [4, 0, 0, "-", "functions"], [7, 0, 0, "-", "input"], [9, 0, 0, "-", "io"], [5, 6, 1, "", "lit"], [5, 6, 1, "", "literal"], [10, 0, 0, "-", "object_store"], [11, 0, 0, "-", "plan"], [5, 6, 1, "", "read_avro"], [5, 6, 1, "", "read_csv"], [5, 6, 1, "", "read_json"], [5, 6, 1, "", "read_parquet"], [12, 0, 0, "-", "record_batch"], [13, 0, 0, "-", "substrait"], [5, 4, 1, "", "udaf"], [14, 0, 0, "-", "udf"], [5, 4, 1, "", "udwf"]], "datafusion.Accumulator": [[5, 2, 1, "", "evaluate"], [5, 2, 1, "", "merge"], [5, 2, 1, "", "state"], [5, 2, 1, "", "update"]], "datafusion.AggregateUDF": [[5, 2, 1, "", "__call__"], [5, 3, 1, "", "_udaf"], [5, 2, 1, "", "udaf"]], "datafusion.Catalog": [[5, 3, 1, "", "catalog"], [5, 2, 1, "", "database"], [5, 2, 1, "", "names"]], "datafusion.Database": [[5, 3, 1, "", "db"], [5, 2, 1, "", "names"], [5, 2, 1, "", "table"]], "datafusion.ExecutionPlan": [[5, 2, 1, "", "__repr__"], [5, 3, 1, "", "_raw_plan"], [5, 2, 1, "", "children"], [5, 2, 1, "", "display"], [5, 2, 1, "", "display_indent"], [5, 2, 1, "", "from_proto"], [5, 5, 1, "", "partition_count"], [5, 2, 1, "", "to_proto"]], "datafusion.Expr": [[5, 2, 1, "", "__add__"], [5, 2, 1, "", "__and__"], [5, 2, 1, "", "__eq__"], [5, 2, 1, "", "__ge__"], [5, 2, 1, "", "__getitem__"], [5, 2, 1, "", "__gt__"], [5, 2, 1, "", "__invert__"], [5, 2, 1, "", "__le__"], [5, 2, 1, "", "__lt__"], [5, 2, 1, "", "__mod__"], [5, 2, 1, "", "__mul__"], [5, 2, 1, "", "__ne__"], [5, 2, 1, "", "__or__"], [5, 3, 1, "", "__radd__"], [5, 3, 1, "", "__rand__"], [5, 2, 1, "", "__repr__"], [5, 2, 1, "", "__richcmp__"], [5, 3, 1, "", "__rmod__"], [5, 3, 1, "", "__rmul__"], [5, 3, 1, "", "__ror__"], [5, 3, 1, "", "__rsub__"], [5, 3, 1, "", "__rtruediv__"], [5, 2, 1, "", "__sub__"], [5, 2, 1, "", "__truediv__"], [5, 3, 1, "", "_to_pyarrow_types"], [5, 2, 1, "", "alias"], [5, 2, 1, "", "between"], [5, 2, 1, "", "canonical_name"], [5, 2, 1, "", "cast"], [5, 2, 1, "", "column"], [5, 2, 1, "", "column_name"], [5, 2, 1, "", "display_name"], [5, 2, 1, "", "distinct"], [5, 3, 1, "", "expr"], [5, 2, 1, "", "fill_nan"], [5, 2, 1, "", "fill_null"], [5, 2, 1, "", "filter"], [5, 2, 1, "", "is_not_null"], [5, 2, 1, "", "is_null"], [5, 2, 1, "", "literal"], [5, 2, 1, "", "null_treatment"], [5, 2, 1, "", "order_by"], [5, 2, 1, "", "over"], [5, 2, 1, "", "partition_by"], [5, 2, 1, "", "python_value"], [5, 2, 1, "", "rex_call_operands"], [5, 2, 1, "", "rex_call_operator"], [5, 2, 1, "", "rex_type"], [5, 2, 1, "", "schema_name"], [5, 2, 1, "", "sort"], [5, 2, 1, "", "string_literal"], [5, 2, 1, "", "to_variant"], [5, 2, 1, "", "types"], [5, 2, 1, "", "variant_name"], [5, 2, 1, "", "window_frame"]], "datafusion.LogicalPlan": [[5, 2, 1, "", "__repr__"], [5, 3, 1, "", "_raw_plan"], [5, 2, 1, "", "display"], [5, 2, 1, "", "display_graphviz"], [5, 2, 1, "", "display_indent"], [5, 2, 1, "", "display_indent_schema"], [5, 2, 1, "", "from_proto"], [5, 2, 1, "", "inputs"], [5, 2, 1, "", "to_proto"], [5, 2, 1, "", "to_variant"]], "datafusion.RecordBatch": [[5, 3, 1, "", "record_batch"], [5, 2, 1, "", "to_pyarrow"]], "datafusion.RecordBatchStream": [[5, 2, 1, "", "__aiter__"], [5, 2, 1, "", "__anext__"], [5, 2, 1, "", "__iter__"], [5, 2, 1, "", "__next__"], [5, 2, 1, "", "next"], [5, 3, 1, "", "rbs"]], "datafusion.RuntimeEnvBuilder": [[5, 3, 1, "", "config_internal"], [5, 2, 1, "", "with_disk_manager_disabled"], [5, 2, 1, "", "with_disk_manager_os"], [5, 2, 1, "", "with_disk_manager_specified"], [5, 2, 1, "", "with_fair_spill_pool"], [5, 2, 1, "", "with_greedy_memory_pool"], [5, 2, 1, "", "with_temp_file_path"], [5, 2, 1, "", "with_unbounded_memory_pool"]], "datafusion.SQLOptions": [[5, 3, 1, "", "options_internal"], [5, 2, 1, "", "with_allow_ddl"], [5, 2, 1, "", "with_allow_dml"], [5, 2, 1, "", "with_allow_statements"]], "datafusion.ScalarUDF": [[5, 2, 1, "", "__call__"], [5, 3, 1, "", "_udf"], [5, 2, 1, "", "udf"]], "datafusion.SessionConfig": [[5, 3, 1, "", "config_internal"], [5, 2, 1, "", "set"], [5, 2, 1, "", "with_batch_size"], [5, 2, 1, "", "with_create_default_catalog_and_schema"], [5, 2, 1, "", "with_default_catalog_and_schema"], [5, 2, 1, "", "with_information_schema"], [5, 2, 1, "", "with_parquet_pruning"], [5, 2, 1, "", "with_repartition_aggregations"], [5, 2, 1, "", "with_repartition_file_min_size"], [5, 2, 1, "", "with_repartition_file_scans"], [5, 2, 1, "", "with_repartition_joins"], [5, 2, 1, "", "with_repartition_sorts"], [5, 2, 1, "", "with_repartition_windows"], [5, 2, 1, "", "with_target_partitions"]], "datafusion.Table": [[5, 5, 1, "", "kind"], [5, 5, 1, "", "schema"], [5, 3, 1, "", "table"]], "datafusion.WindowFrame": [[5, 2, 1, "", "get_frame_units"], [5, 2, 1, "", "get_lower_bound"], [5, 2, 1, "", "get_upper_bound"], [5, 3, 1, "", "window_frame"]], "datafusion.WindowUDF": [[5, 2, 1, "", "__call__"], [5, 2, 1, "", "_create_window_udf"], [5, 2, 1, "", "_create_window_udf_decorator"], [5, 2, 1, "", "_get_default_name"], [5, 2, 1, "", "_normalize_input_types"], [5, 3, 1, "", "_udwf"], [5, 2, 1, "", "udwf"]], "datafusion.catalog": [[0, 1, 1, "", "Catalog"], [0, 1, 1, "", "Database"], [0, 1, 1, "", "Table"]], "datafusion.catalog.Catalog": [[0, 3, 1, "", "catalog"], [0, 2, 1, "", "database"], [0, 2, 1, "", "names"]], "datafusion.catalog.Database": [[0, 3, 1, "", "db"], [0, 2, 1, "", "names"], [0, 2, 1, "", "table"]], "datafusion.catalog.Table": [[0, 5, 1, "", "kind"], [0, 5, 1, "", "schema"], [0, 3, 1, "", "table"]], "datafusion.context": [[1, 1, 1, "", "ArrowArrayExportable"], [1, 1, 1, "", "ArrowStreamExportable"], [1, 1, 1, "", "RuntimeConfig"], [1, 1, 1, "", "RuntimeEnvBuilder"], [1, 1, 1, "", "SQLOptions"], [1, 1, 1, "", "SessionConfig"], [1, 1, 1, "", "SessionContext"], [1, 1, 1, "", "TableProviderExportable"]], "datafusion.context.ArrowArrayExportable": [[1, 2, 1, "", "__arrow_c_array__"]], "datafusion.context.ArrowStreamExportable": [[1, 2, 1, "", "__arrow_c_stream__"]], "datafusion.context.RuntimeEnvBuilder": [[1, 3, 1, "", "config_internal"], [1, 2, 1, "", "with_disk_manager_disabled"], [1, 2, 1, "", "with_disk_manager_os"], [1, 2, 1, "", "with_disk_manager_specified"], [1, 2, 1, "", "with_fair_spill_pool"], [1, 2, 1, "", "with_greedy_memory_pool"], [1, 2, 1, "", "with_temp_file_path"], [1, 2, 1, "", "with_unbounded_memory_pool"]], "datafusion.context.SQLOptions": [[1, 3, 1, "", "options_internal"], [1, 2, 1, "", "with_allow_ddl"], [1, 2, 1, "", "with_allow_dml"], [1, 2, 1, "", "with_allow_statements"]], "datafusion.context.SessionConfig": [[1, 3, 1, "", "config_internal"], [1, 2, 1, "", "set"], [1, 2, 1, "", "with_batch_size"], [1, 2, 1, "", "with_create_default_catalog_and_schema"], [1, 2, 1, "", "with_default_catalog_and_schema"], [1, 2, 1, "", "with_information_schema"], [1, 2, 1, "", "with_parquet_pruning"], [1, 2, 1, "", "with_repartition_aggregations"], [1, 2, 1, "", "with_repartition_file_min_size"], [1, 2, 1, "", "with_repartition_file_scans"], [1, 2, 1, "", "with_repartition_joins"], [1, 2, 1, "", "with_repartition_sorts"], [1, 2, 1, "", "with_repartition_windows"], [1, 2, 1, "", "with_target_partitions"]], "datafusion.context.SessionContext": [[1, 2, 1, "", "catalog"], [1, 2, 1, "", "create_dataframe"], [1, 2, 1, "", "create_dataframe_from_logical_plan"], [1, 3, 1, "", "ctx"], [1, 2, 1, "", "deregister_table"], [1, 2, 1, "", "empty_table"], [1, 2, 1, "", "enable_url_table"], [1, 2, 1, "", "execute"], [1, 2, 1, "", "from_arrow"], [1, 2, 1, "", "from_arrow_table"], [1, 2, 1, "", "from_pandas"], [1, 2, 1, "", "from_polars"], [1, 2, 1, "", "from_pydict"], [1, 2, 1, "", "from_pylist"], [1, 2, 1, "", "global_ctx"], [1, 2, 1, "", "read_avro"], [1, 2, 1, "", "read_csv"], [1, 2, 1, "", "read_json"], [1, 2, 1, "", "read_parquet"], [1, 2, 1, "", "read_table"], [1, 2, 1, "", "register_avro"], [1, 2, 1, "", "register_csv"], [1, 2, 1, "", "register_dataset"], [1, 2, 1, "", "register_json"], [1, 2, 1, "", "register_listing_table"], [1, 2, 1, "", "register_object_store"], [1, 2, 1, "", "register_parquet"], [1, 2, 1, "", "register_record_batches"], [1, 2, 1, "", "register_table"], [1, 2, 1, "", "register_table_provider"], [1, 2, 1, "", "register_udaf"], [1, 2, 1, "", "register_udf"], [1, 2, 1, "", "register_udwf"], [1, 2, 1, "", "register_view"], [1, 2, 1, "", "session_id"], [1, 2, 1, "", "sql"], [1, 2, 1, "", "sql_with_options"], [1, 2, 1, "", "table"], [1, 2, 1, "", "table_exist"]], "datafusion.context.TableProviderExportable": [[1, 2, 1, "", "__datafusion_table_provider__"]], "datafusion.dataframe": [[2, 1, 1, "", "Compression"], [2, 1, 1, "", "DataFrame"]], "datafusion.dataframe.Compression": [[2, 3, 1, "", "BROTLI"], [2, 3, 1, "", "GZIP"], [2, 3, 1, "", "LZ4"], [2, 3, 1, "", "LZ4_RAW"], [2, 3, 1, "", "SNAPPY"], [2, 3, 1, "", "UNCOMPRESSED"], [2, 3, 1, "", "ZSTD"], [2, 2, 1, "", "from_str"], [2, 2, 1, "", "get_default_level"]], "datafusion.dataframe.DataFrame": [[2, 2, 1, "", "__arrow_c_stream__"], [2, 2, 1, "", "__getitem__"], [2, 2, 1, "", "__repr__"], [2, 2, 1, "", "_repr_html_"], [2, 2, 1, "", "aggregate"], [2, 2, 1, "", "cache"], [2, 2, 1, "", "cast"], [2, 2, 1, "", "collect"], [2, 2, 1, "", "collect_partitioned"], [2, 2, 1, "", "count"], [2, 2, 1, "", "describe"], [2, 3, 1, "", "df"], [2, 2, 1, "", "distinct"], [2, 2, 1, "", "drop"], [2, 2, 1, "", "except_all"], [2, 2, 1, "", "execute_stream"], [2, 2, 1, "", "execute_stream_partitioned"], [2, 2, 1, "", "execution_plan"], [2, 2, 1, "", "explain"], [2, 2, 1, "", "filter"], [2, 2, 1, "", "head"], [2, 2, 1, "", "intersect"], [2, 2, 1, "", "into_view"], [2, 2, 1, "", "join"], [2, 2, 1, "", "join_on"], [2, 2, 1, "", "limit"], [2, 2, 1, "", "logical_plan"], [2, 2, 1, "", "optimized_logical_plan"], [2, 2, 1, "", "repartition"], [2, 2, 1, "", "repartition_by_hash"], [2, 2, 1, "", "schema"], [2, 2, 1, "", "select"], [2, 2, 1, "", "select_columns"], [2, 2, 1, "", "show"], [2, 2, 1, "", "sort"], [2, 2, 1, "", "tail"], [2, 2, 1, "", "to_arrow_table"], [2, 2, 1, "", "to_pandas"], [2, 2, 1, "", "to_polars"], [2, 2, 1, "", "to_pydict"], [2, 2, 1, "", "to_pylist"], [2, 2, 1, "", "transform"], [2, 2, 1, "", "union"], [2, 2, 1, "", "union_distinct"], [2, 2, 1, "", "unnest_columns"], [2, 2, 1, "", "with_column"], [2, 2, 1, "", "with_column_renamed"], [2, 2, 1, "", "with_columns"], [2, 2, 1, "", "write_csv"], [2, 2, 1, "", "write_json"], [2, 2, 1, "", "write_parquet"]], "datafusion.expr": [[3, 4, 1, "", "Aggregate"], [3, 4, 1, "", "AggregateFunction"], [3, 4, 1, "", "Alias"], [3, 4, 1, "", "Analyze"], [3, 4, 1, "", "Between"], [3, 4, 1, "", "BinaryExpr"], [3, 4, 1, "", "Case"], [3, 1, 1, "", "CaseBuilder"], [3, 4, 1, "", "Cast"], [3, 4, 1, "", "Column"], [3, 4, 1, "", "CreateMemoryTable"], [3, 4, 1, "", "CreateView"], [3, 4, 1, "", "Distinct"], [3, 4, 1, "", "DropTable"], [3, 4, 1, "", "EmptyRelation"], [3, 4, 1, "", "Exists"], [3, 4, 1, "", "Explain"], [3, 1, 1, "", "Expr"], [3, 4, 1, "", "Extension"], [3, 4, 1, "", "Filter"], [3, 4, 1, "", "GroupingSet"], [3, 4, 1, "", "ILike"], [3, 4, 1, "", "InList"], [3, 4, 1, "", "InSubquery"], [3, 4, 1, "", "IsFalse"], [3, 4, 1, "", "IsNotFalse"], [3, 4, 1, "", "IsNotNull"], [3, 4, 1, "", "IsNotTrue"], [3, 4, 1, "", "IsNotUnknown"], [3, 4, 1, "", "IsNull"], [3, 4, 1, "", "IsTrue"], [3, 4, 1, "", "IsUnknown"], [3, 4, 1, "", "Join"], [3, 4, 1, "", "JoinConstraint"], [3, 4, 1, "", "JoinType"], [3, 4, 1, "", "Like"], [3, 4, 1, "", "Limit"], [3, 4, 1, "", "Literal"], [3, 4, 1, "", "Negative"], [3, 4, 1, "", "Not"], [3, 4, 1, "", "Partitioning"], [3, 4, 1, "", "Placeholder"], [3, 4, 1, "", "Projection"], [3, 4, 1, "", "Repartition"], [3, 4, 1, "", "ScalarSubquery"], [3, 4, 1, "", "ScalarVariable"], [3, 4, 1, "", "SimilarTo"], [3, 4, 1, "", "Sort"], [3, 1, 1, "", "SortExpr"], [3, 4, 1, "", "Subquery"], [3, 4, 1, "", "SubqueryAlias"], [3, 4, 1, "", "TableScan"], [3, 4, 1, "", "TryCast"], [3, 4, 1, "", "Union"], [3, 4, 1, "", "Unnest"], [3, 4, 1, "", "UnnestExpr"], [3, 1, 1, "", "Window"], [3, 4, 1, "", "WindowExpr"], [3, 1, 1, "", "WindowFrame"], [3, 1, 1, "", "WindowFrameBound"]], "datafusion.expr.CaseBuilder": [[3, 3, 1, "", "case_builder"], [3, 2, 1, "", "end"], [3, 2, 1, "", "otherwise"], [3, 2, 1, "", "when"]], "datafusion.expr.Expr": [[3, 2, 1, "", "__add__"], [3, 2, 1, "", "__and__"], [3, 2, 1, "", "__eq__"], [3, 2, 1, "", "__ge__"], [3, 2, 1, "", "__getitem__"], [3, 2, 1, "", "__gt__"], [3, 2, 1, "", "__invert__"], [3, 2, 1, "", "__le__"], [3, 2, 1, "", "__lt__"], [3, 2, 1, "", "__mod__"], [3, 2, 1, "", "__mul__"], [3, 2, 1, "", "__ne__"], [3, 2, 1, "", "__or__"], [3, 3, 1, "", "__radd__"], [3, 3, 1, "", "__rand__"], [3, 2, 1, "", "__repr__"], [3, 2, 1, "", "__richcmp__"], [3, 3, 1, "", "__rmod__"], [3, 3, 1, "", "__rmul__"], [3, 3, 1, "", "__ror__"], [3, 3, 1, "", "__rsub__"], [3, 3, 1, "", "__rtruediv__"], [3, 2, 1, "", "__sub__"], [3, 2, 1, "", "__truediv__"], [3, 3, 1, "", "_to_pyarrow_types"], [3, 2, 1, "", "alias"], [3, 2, 1, "", "between"], [3, 2, 1, "", "canonical_name"], [3, 2, 1, "", "cast"], [3, 2, 1, "", "column"], [3, 2, 1, "", "column_name"], [3, 2, 1, "", "display_name"], [3, 2, 1, "", "distinct"], [3, 3, 1, "", "expr"], [3, 2, 1, "", "fill_nan"], [3, 2, 1, "", "fill_null"], [3, 2, 1, "", "filter"], [3, 2, 1, "", "is_not_null"], [3, 2, 1, "", "is_null"], [3, 2, 1, "", "literal"], [3, 2, 1, "", "null_treatment"], [3, 2, 1, "", "order_by"], [3, 2, 1, "", "over"], [3, 2, 1, "", "partition_by"], [3, 2, 1, "", "python_value"], [3, 2, 1, "", "rex_call_operands"], [3, 2, 1, "", "rex_call_operator"], [3, 2, 1, "", "rex_type"], [3, 2, 1, "", "schema_name"], [3, 2, 1, "", "sort"], [3, 2, 1, "", "string_literal"], [3, 2, 1, "", "to_variant"], [3, 2, 1, "", "types"], [3, 2, 1, "", "variant_name"], [3, 2, 1, "", "window_frame"]], "datafusion.expr.SortExpr": [[3, 2, 1, "", "__repr__"], [3, 2, 1, "", "ascending"], [3, 2, 1, "", "expr"], [3, 2, 1, "", "nulls_first"], [3, 3, 1, "", "raw_sort"]], "datafusion.expr.Window": [[3, 3, 1, "", "_null_treatment"], [3, 3, 1, "", "_order_by"], [3, 3, 1, "", "_partition_by"], [3, 3, 1, "", "_window_frame"]], "datafusion.expr.WindowFrame": [[3, 2, 1, "", "get_frame_units"], [3, 2, 1, "", "get_lower_bound"], [3, 2, 1, "", "get_upper_bound"], [3, 3, 1, "", "window_frame"]], "datafusion.expr.WindowFrameBound": [[3, 3, 1, "", "frame_bound"], [3, 2, 1, "", "get_offset"], [3, 2, 1, "", "is_current_row"], [3, 2, 1, "", "is_following"], [3, 2, 1, "", "is_preceding"], [3, 2, 1, "", "is_unbounded"]], "datafusion.functions": [[4, 6, 1, "", "abs"], [4, 6, 1, "", "acos"], [4, 6, 1, "", "acosh"], [4, 6, 1, "", "alias"], [4, 6, 1, "", "approx_distinct"], [4, 6, 1, "", "approx_median"], [4, 6, 1, "", "approx_percentile_cont"], [4, 6, 1, "", "approx_percentile_cont_with_weight"], [4, 6, 1, "", "array"], [4, 6, 1, "", "array_agg"], [4, 6, 1, "", "array_append"], [4, 6, 1, "", "array_cat"], [4, 6, 1, "", "array_concat"], [4, 6, 1, "", "array_dims"], [4, 6, 1, "", "array_distinct"], [4, 6, 1, "", "array_element"], [4, 6, 1, "", "array_empty"], [4, 6, 1, "", "array_except"], [4, 6, 1, "", "array_extract"], [4, 6, 1, "", "array_has"], [4, 6, 1, "", "array_has_all"], [4, 6, 1, "", "array_has_any"], [4, 6, 1, "", "array_indexof"], [4, 6, 1, "", "array_intersect"], [4, 6, 1, "", "array_join"], [4, 6, 1, "", "array_length"], [4, 6, 1, "", "array_ndims"], [4, 6, 1, "", "array_pop_back"], [4, 6, 1, "", "array_pop_front"], [4, 6, 1, "", "array_position"], [4, 6, 1, "", "array_positions"], [4, 6, 1, "", "array_prepend"], [4, 6, 1, "", "array_push_back"], [4, 6, 1, "", "array_push_front"], [4, 6, 1, "", "array_remove"], [4, 6, 1, "", "array_remove_all"], [4, 6, 1, "", "array_remove_n"], [4, 6, 1, "", "array_repeat"], [4, 6, 1, "", "array_replace"], [4, 6, 1, "", "array_replace_all"], [4, 6, 1, "", "array_replace_n"], [4, 6, 1, "", "array_resize"], [4, 6, 1, "", "array_slice"], [4, 6, 1, "", "array_sort"], [4, 6, 1, "", "array_to_string"], [4, 6, 1, "", "array_union"], [4, 6, 1, "", "arrow_cast"], [4, 6, 1, "", "arrow_typeof"], [4, 6, 1, "", "ascii"], [4, 6, 1, "", "asin"], [4, 6, 1, "", "asinh"], [4, 6, 1, "", "atan"], [4, 6, 1, "", "atan2"], [4, 6, 1, "", "atanh"], [4, 6, 1, "", "avg"], [4, 6, 1, "", "bit_and"], [4, 6, 1, "", "bit_length"], [4, 6, 1, "", "bit_or"], [4, 6, 1, "", "bit_xor"], [4, 6, 1, "", "bool_and"], [4, 6, 1, "", "bool_or"], [4, 6, 1, "", "btrim"], [4, 6, 1, "", "cardinality"], [4, 6, 1, "", "case"], [4, 6, 1, "", "cbrt"], [4, 6, 1, "", "ceil"], [4, 6, 1, "", "char_length"], [4, 6, 1, "", "character_length"], [4, 6, 1, "", "chr"], [4, 6, 1, "", "coalesce"], [4, 6, 1, "", "col"], [4, 6, 1, "", "concat"], [4, 6, 1, "", "concat_ws"], [4, 6, 1, "", "corr"], [4, 6, 1, "", "cos"], [4, 6, 1, "", "cosh"], [4, 6, 1, "", "cot"], [4, 6, 1, "", "count"], [4, 6, 1, "", "count_star"], [4, 6, 1, "", "covar"], [4, 6, 1, "", "covar_pop"], [4, 6, 1, "", "covar_samp"], [4, 6, 1, "", "cume_dist"], [4, 6, 1, "", "current_date"], [4, 6, 1, "", "current_time"], [4, 6, 1, "", "date_bin"], [4, 6, 1, "", "date_part"], [4, 6, 1, "", "date_trunc"], [4, 6, 1, "", "datepart"], [4, 6, 1, "", "datetrunc"], [4, 6, 1, "", "decode"], [4, 6, 1, "", "degrees"], [4, 6, 1, "", "dense_rank"], [4, 6, 1, "", "digest"], [4, 6, 1, "", "empty"], [4, 6, 1, "", "encode"], [4, 6, 1, "", "ends_with"], [4, 6, 1, "", "exp"], [4, 6, 1, "", "extract"], [4, 6, 1, "", "factorial"], [4, 6, 1, "", "find_in_set"], [4, 6, 1, "", "first_value"], [4, 6, 1, "", "flatten"], [4, 6, 1, "", "floor"], [4, 6, 1, "", "from_unixtime"], [4, 6, 1, "", "gcd"], [4, 6, 1, "", "in_list"], [4, 6, 1, "", "initcap"], [4, 6, 1, "", "isnan"], [4, 6, 1, "", "iszero"], [4, 6, 1, "", "lag"], [4, 6, 1, "", "last_value"], [4, 6, 1, "", "lcm"], [4, 6, 1, "", "lead"], [4, 6, 1, "", "left"], [4, 6, 1, "", "length"], [4, 6, 1, "", "levenshtein"], [4, 6, 1, "", "list_append"], [4, 6, 1, "", "list_cat"], [4, 6, 1, "", "list_concat"], [4, 6, 1, "", "list_dims"], [4, 6, 1, "", "list_distinct"], [4, 6, 1, "", "list_element"], [4, 6, 1, "", "list_except"], [4, 6, 1, "", "list_extract"], [4, 6, 1, "", "list_indexof"], [4, 6, 1, "", "list_intersect"], [4, 6, 1, "", "list_join"], [4, 6, 1, "", "list_length"], [4, 6, 1, "", "list_ndims"], [4, 6, 1, "", "list_position"], [4, 6, 1, "", "list_positions"], [4, 6, 1, "", "list_prepend"], [4, 6, 1, "", "list_push_back"], [4, 6, 1, "", "list_push_front"], [4, 6, 1, "", "list_remove"], [4, 6, 1, "", "list_remove_all"], [4, 6, 1, "", "list_remove_n"], [4, 6, 1, "", "list_repeat"], [4, 6, 1, "", "list_replace"], [4, 6, 1, "", "list_replace_all"], [4, 6, 1, "", "list_replace_n"], [4, 6, 1, "", "list_resize"], [4, 6, 1, "", "list_slice"], [4, 6, 1, "", "list_sort"], [4, 6, 1, "", "list_to_string"], [4, 6, 1, "", "list_union"], [4, 6, 1, "", "ln"], [4, 6, 1, "", "log"], [4, 6, 1, "", "log10"], [4, 6, 1, "", "log2"], [4, 6, 1, "", "lower"], [4, 6, 1, "", "lpad"], [4, 6, 1, "", "ltrim"], [4, 6, 1, "", "make_array"], [4, 6, 1, "", "make_date"], [4, 6, 1, "", "make_list"], [4, 6, 1, "", "max"], [4, 6, 1, "", "md5"], [4, 6, 1, "", "mean"], [4, 6, 1, "", "median"], [4, 6, 1, "", "min"], [4, 6, 1, "", "named_struct"], [4, 6, 1, "", "nanvl"], [4, 6, 1, "", "now"], [4, 6, 1, "", "nth_value"], [4, 6, 1, "", "ntile"], [4, 6, 1, "", "nullif"], [4, 6, 1, "", "nvl"], [4, 6, 1, "", "octet_length"], [4, 6, 1, "", "order_by"], [4, 6, 1, "", "overlay"], [4, 6, 1, "", "percent_rank"], [4, 6, 1, "", "pi"], [4, 6, 1, "", "pow"], [4, 6, 1, "", "power"], [4, 6, 1, "", "radians"], [4, 6, 1, "", "random"], [4, 6, 1, "", "range"], [4, 6, 1, "", "rank"], [4, 6, 1, "", "regexp_count"], [4, 6, 1, "", "regexp_like"], [4, 6, 1, "", "regexp_match"], [4, 6, 1, "", "regexp_replace"], [4, 6, 1, "", "regr_avgx"], [4, 6, 1, "", "regr_avgy"], [4, 6, 1, "", "regr_count"], [4, 6, 1, "", "regr_intercept"], [4, 6, 1, "", "regr_r2"], [4, 6, 1, "", "regr_slope"], [4, 6, 1, "", "regr_sxx"], [4, 6, 1, "", "regr_sxy"], [4, 6, 1, "", "regr_syy"], [4, 6, 1, "", "repeat"], [4, 6, 1, "", "replace"], [4, 6, 1, "", "reverse"], [4, 6, 1, "", "right"], [4, 6, 1, "", "round"], [4, 6, 1, "", "row_number"], [4, 6, 1, "", "rpad"], [4, 6, 1, "", "rtrim"], [4, 6, 1, "", "sha224"], [4, 6, 1, "", "sha256"], [4, 6, 1, "", "sha384"], [4, 6, 1, "", "sha512"], [4, 6, 1, "", "signum"], [4, 6, 1, "", "sin"], [4, 6, 1, "", "sinh"], [4, 6, 1, "", "split_part"], [4, 6, 1, "", "sqrt"], [4, 6, 1, "", "starts_with"], [4, 6, 1, "", "stddev"], [4, 6, 1, "", "stddev_pop"], [4, 6, 1, "", "stddev_samp"], [4, 6, 1, "", "string_agg"], [4, 6, 1, "", "strpos"], [4, 6, 1, "", "struct"], [4, 6, 1, "", "substr"], [4, 6, 1, "", "substr_index"], [4, 6, 1, "", "substring"], [4, 6, 1, "", "sum"], [4, 6, 1, "", "tan"], [4, 6, 1, "", "tanh"], [4, 6, 1, "", "to_hex"], [4, 6, 1, "", "to_timestamp"], [4, 6, 1, "", "to_timestamp_micros"], [4, 6, 1, "", "to_timestamp_millis"], [4, 6, 1, "", "to_timestamp_nanos"], [4, 6, 1, "", "to_timestamp_seconds"], [4, 6, 1, "", "to_unixtime"], [4, 6, 1, "", "translate"], [4, 6, 1, "", "trim"], [4, 6, 1, "", "trunc"], [4, 6, 1, "", "upper"], [4, 6, 1, "", "uuid"], [4, 6, 1, "", "var"], [4, 6, 1, "", "var_pop"], [4, 6, 1, "", "var_samp"], [4, 6, 1, "", "var_sample"], [4, 6, 1, "", "when"], [4, 6, 1, "", "window"]], "datafusion.input": [[7, 1, 1, "", "LocationInputPlugin"], [6, 0, 0, "-", "base"], [8, 0, 0, "-", "location"]], "datafusion.input.LocationInputPlugin": [[7, 2, 1, "", "build_table"], [7, 2, 1, "", "is_correct_input"]], "datafusion.input.base": [[6, 1, 1, "", "BaseInputSource"]], "datafusion.input.base.BaseInputSource": [[6, 2, 1, "", "build_table"], [6, 2, 1, "", "is_correct_input"]], "datafusion.input.location": [[8, 1, 1, "", "LocationInputPlugin"]], "datafusion.input.location.LocationInputPlugin": [[8, 2, 1, "", "build_table"], [8, 2, 1, "", "is_correct_input"]], "datafusion.io": [[9, 6, 1, "", "read_avro"], [9, 6, 1, "", "read_csv"], [9, 6, 1, "", "read_json"], [9, 6, 1, "", "read_parquet"]], "datafusion.object_store": [[10, 4, 1, "", "AmazonS3"], [10, 4, 1, "", "GoogleCloud"], [10, 4, 1, "", "Http"], [10, 4, 1, "", "LocalFileSystem"], [10, 4, 1, "", "MicrosoftAzure"]], "datafusion.plan": [[11, 1, 1, "", "ExecutionPlan"], [11, 1, 1, "", "LogicalPlan"]], "datafusion.plan.ExecutionPlan": [[11, 2, 1, "", "__repr__"], [11, 3, 1, "", "_raw_plan"], [11, 2, 1, "", "children"], [11, 2, 1, "", "display"], [11, 2, 1, "", "display_indent"], [11, 2, 1, "", "from_proto"], [11, 5, 1, "", "partition_count"], [11, 2, 1, "", "to_proto"]], "datafusion.plan.LogicalPlan": [[11, 2, 1, "", "__repr__"], [11, 3, 1, "", "_raw_plan"], [11, 2, 1, "", "display"], [11, 2, 1, "", "display_graphviz"], [11, 2, 1, "", "display_indent"], [11, 2, 1, "", "display_indent_schema"], [11, 2, 1, "", "from_proto"], [11, 2, 1, "", "inputs"], [11, 2, 1, "", "to_proto"], [11, 2, 1, "", "to_variant"]], "datafusion.record_batch": [[12, 1, 1, "", "RecordBatch"], [12, 1, 1, "", "RecordBatchStream"]], "datafusion.record_batch.RecordBatch": [[12, 3, 1, "", "record_batch"], [12, 2, 1, "", "to_pyarrow"]], "datafusion.record_batch.RecordBatchStream": [[12, 2, 1, "", "__aiter__"], [12, 2, 1, "", "__anext__"], [12, 2, 1, "", "__iter__"], [12, 2, 1, "", "__next__"], [12, 2, 1, "", "next"], [12, 3, 1, "", "rbs"]], "datafusion.substrait": [[13, 1, 1, "", "Consumer"], [13, 1, 1, "", "Plan"], [13, 1, 1, "", "Producer"], [13, 1, 1, "", "Serde"]], "datafusion.substrait.Consumer": [[13, 2, 1, "", "from_substrait_plan"]], "datafusion.substrait.Plan": [[13, 2, 1, "", "encode"], [13, 3, 1, "", "plan_internal"]], "datafusion.substrait.Producer": [[13, 2, 1, "", "to_substrait_plan"]], "datafusion.substrait.Serde": [[13, 2, 1, "", "deserialize"], [13, 2, 1, "", "deserialize_bytes"], [13, 2, 1, "", "serialize"], [13, 2, 1, "", "serialize_bytes"], [13, 2, 1, "", "serialize_to_plan"]], "datafusion.udf": [[14, 1, 1, "", "Accumulator"], [14, 1, 1, "", "AggregateUDF"], [14, 1, 1, "", "ScalarUDF"], [14, 1, 1, "", "Volatility"], [14, 1, 1, "", "WindowEvaluator"], [14, 1, 1, "", "WindowUDF"], [14, 4, 1, "", "_R"], [14, 4, 1, "", "udaf"], [14, 4, 1, "", "udf"], [14, 4, 1, "", "udwf"]], "datafusion.udf.Accumulator": [[14, 2, 1, "", "evaluate"], [14, 2, 1, "", "merge"], [14, 2, 1, "", "state"], [14, 2, 1, "", "update"]], "datafusion.udf.AggregateUDF": [[14, 2, 1, "", "__call__"], [14, 3, 1, "", "_udaf"], [14, 2, 1, "", "udaf"]], "datafusion.udf.ScalarUDF": [[14, 2, 1, "", "__call__"], [14, 3, 1, "", "_udf"], [14, 2, 1, "", "udf"]], "datafusion.udf.Volatility": [[14, 3, 1, "", "Immutable"], [14, 3, 1, "", "Stable"], [14, 3, 1, "", "Volatile"], [14, 2, 1, "", "__str__"]], "datafusion.udf.WindowEvaluator": [[14, 2, 1, "", "evaluate"], [14, 2, 1, "", "evaluate_all"], [14, 2, 1, "", "evaluate_all_with_rank"], [14, 2, 1, "", "get_range"], [14, 2, 1, "", "include_rank"], [14, 2, 1, "", "is_causal"], [14, 2, 1, "", "memoize"], [14, 2, 1, "", "supports_bounded_execution"], [14, 2, 1, "", "uses_window_frame"]], "datafusion.udf.WindowUDF": [[14, 2, 1, "", "__call__"], [14, 2, 1, "", "_create_window_udf"], [14, 2, 1, "", "_create_window_udf_decorator"], [14, 2, 1, "", "_get_default_name"], [14, 2, 1, "", "_normalize_input_types"], [14, 3, 1, "", "_udwf"], [14, 2, 1, "", "udwf"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "data", "Python data"], "5": ["py", "property", "Python property"], "6": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute", "4": "py:data", "5": "py:property", "6": "py:function"}, "terms": {"": [1, 2, 3, 4, 5, 14, 16, 17, 22, 25, 27, 28, 29, 30], "0": [2, 3, 4, 5, 14, 19, 20, 21, 22, 23, 26, 27, 29, 31, 32, 39, 40], "00": 23, "01": [19, 23, 26], "01t00": 23, "03": 23, "04023": 4, "05": [23, 26], "06": [23, 26], "08": 23, "09": [19, 23], "1": [2, 3, 4, 5, 14, 15, 17, 18, 19, 20, 21, 22, 23, 25, 26, 27, 28, 29, 31, 32, 33, 40], "10": [4, 5, 14, 18, 19, 20, 22, 23, 26, 27, 28, 29, 31, 32, 40], "100": [4, 18, 19, 20, 29, 31, 32], "1000": [1, 5, 9, 21], "10000000": 30, "1024": [1, 5], "103": [18, 31, 32], "104": [18, 31, 32], "105": [18, 20, 31, 32], "107": 20, "109": [18, 31, 32, 40], "11": [18, 19, 20, 22, 23, 27, 29, 31, 32], "110": 20, "111": [18, 31, 32], "112": 20, "115": [18, 20, 31, 32], "12": [17, 18, 19, 20, 22, 23, 27, 29, 31, 32], "120": [4, 18, 20, 31, 32], "121": 20, "122": [18, 31, 32], "123": [18, 21, 31, 32], "12371": 4, "125": [4, 20, 23, 40], "128": 4, "13": [18, 20, 22, 23, 27, 29, 31, 32], "130": [18, 31, 32], "135": [18, 31, 32], "136": 20, "14": [18, 19, 20, 22, 23, 26, 27, 31, 32], "140": 20, "14097612086726": 21, "145": [18, 20, 31, 32], "149": 40, "15": [18, 19, 20, 22, 23, 26, 27, 29, 31, 32], "150": [18, 29, 31, 32], "158": 40, "159": [18, 31, 32, 40], "16": [19, 20, 22, 23, 27], "160": 40, "161": 40, "162": 40, "163": 40, "165": [23, 40], "17": [19, 20, 22, 23, 27, 29], "18": [19, 20, 22, 23, 27, 29], "19": [20, 22, 23, 40], "190": 40, "1902": 4, "1921": 23, "195": [18, 31, 32], "1970": 23, "2": [2, 3, 4, 5, 14, 18, 19, 20, 21, 22, 23, 25, 26, 27, 28, 29, 31, 32, 33, 40], "20": [2, 4, 5, 14, 18, 20, 22, 23, 28, 29, 31, 32, 40], "200": 40, "2025": 23, "205": [18, 31, 32], "21": [19, 20, 22, 23, 29], "22": [2, 22, 31], "223": 40, "224": 4, "229": 40, "23": [19, 22, 29, 40], "23076923076923": 20, "2345": 4, "24": [19, 22], "25": [4, 18, 20, 22, 23, 29, 31, 32], "256": 4, "25806451612904": 20, "26": [22, 29], "27": 22, "28": [19, 22, 29], "28571428571429": 20, "29": 22, "3": [2, 4, 14, 17, 18, 19, 20, 21, 22, 23, 25, 26, 27, 28, 29, 31, 32, 33, 40], "30": [18, 20, 22, 28, 29, 31, 32], "309": [18, 23, 31, 32], "30t17": 23, "31": 22, "314": [18, 23, 31, 32], "318": [18, 23, 31, 32], "32": 22, "33": [19, 22], "333333333333332": 29, "333333333333336": 20, "34": [22, 23], "35": [18, 19, 20, 22, 26, 29, 31, 32], "36": [19, 22], "37": 22, "38": 22, "384": 4, "39": [18, 22, 31, 32, 40], "395": [18, 31, 32], "3rd": 4, "4": [2, 4, 14, 18, 19, 20, 21, 22, 23, 25, 26, 27, 28, 29, 31, 32, 33, 40], "40": [4, 17, 18, 20, 22, 28, 31, 32], "405": [18, 23, 31, 32], "41": 22, "42": [20, 22, 29, 31], "42857142857143": 29, "43": [18, 22, 29, 31, 32, 39], "44": [18, 22, 31, 32], "45": [18, 20, 22, 23, 29, 31, 32], "4579": 23, "46": [20, 32], "47": 20, "4732": 23, "48": [18, 20, 31, 32], "49": [18, 23, 31, 32], "495": [18, 31, 32], "5": [2, 4, 14, 18, 19, 20, 21, 22, 23, 25, 26, 27, 28, 29, 31, 32, 33, 40], "50": [4, 18, 20, 28, 31, 32], "51": [19, 20], "512": 4, "5129": 23, "52": [18, 20, 31, 32], "525": [18, 23, 31, 32], "53": 20, "530": [18, 31, 32], "531": 21, "534": [18, 23, 31, 32], "536576280z": 23, "54": [20, 22, 23], "55": [18, 20, 29, 31, 32], "56": 20, "58": [18, 20, 31, 32], "5811388300841898": 21, "59": [18, 31, 32], "6": [18, 19, 20, 21, 22, 23, 25, 26, 27, 29, 31, 32, 33, 40], "60": [4, 18, 20, 29, 31, 32], "62": [18, 31, 32], "625": [18, 23, 31, 32], "63": [18, 20, 31, 32], "630": [18, 31, 32], "634": [18, 23, 31, 32], "64": [17, 18, 29, 31, 32], "65": [18, 20, 22, 26, 29, 31, 32], "66": [19, 20], "666666666666668": 29, "66666666666667": 20, "666667": 4, "669": 21, "67": [20, 22], "7": [18, 19, 20, 21, 22, 23, 25, 26, 27, 29, 31, 32, 33, 40], "70": [18, 20, 29, 31, 32], "71": [20, 22], "72": 20, "721": 21, "73": 19, "732": 23, "75": [4, 18, 20, 31, 32], "76": 29, "774": 21, "77777777777777": 20, "78": [18, 19, 31, 32], "785714285714285": 20, "78571428571429": 20, "79": [18, 19, 31, 32], "8": [18, 19, 20, 21, 22, 23, 25, 26, 27, 29, 30, 31, 32, 33], "80": [4, 18, 20, 29, 31, 32], "803": 21, "81": 19, "82": [18, 31, 32], "83": [18, 20, 31, 32], "832": 21, "833333333333336": 20, "84": [18, 29, 31, 32], "85": [18, 20, 31, 32], "855": 23, "86": 20, "86740bfd3d9831d6b7c1d0e1bf4a21d91598a0ac": [3, 5], "88888888888889": 20, "9": [4, 17, 18, 19, 20, 21, 22, 23, 25, 26, 27, 29, 31, 32, 33, 40], "90": [4, 18, 20, 29, 31, 32], "91": 20, "92": 19, "94": [19, 26], "95": [19, 20, 29, 40], "96": [19, 20], "972": 23, "98": [20, 40], "A": [1, 2, 3, 4, 5, 6, 11, 13, 14, 19, 21, 25, 29, 39], "AND": [2, 3, 4, 5, 14], "As": [4, 5, 14, 16, 22, 26, 31], "At": [4, 16], "BY": 14, "Be": 2, "By": [2, 16, 17, 20], "For": [1, 2, 4, 13, 14, 16, 17, 20, 22, 23, 25, 26, 27, 32], "INTO": [1, 5], "If": [1, 2, 3, 4, 5, 6, 9, 14, 16, 17, 20, 23, 25, 27, 29, 32, 39], "In": [5, 14, 16, 17, 18, 19, 20, 21, 22, 23, 25, 26, 27, 29, 31, 32, 33, 40], "It": [1, 2, 3, 4, 5, 14, 16, 18, 19, 20, 22, 25, 33, 38], "Its": 18, "No": 2, "Not": [3, 5], "OR": [3, 4, 5], "On": [2, 16, 31], "One": [2, 3, 16, 20, 29], "That": [3, 5, 33], "The": [1, 2, 4, 5, 7, 8, 9, 11, 13, 14, 17, 18, 19, 20, 21, 22, 23, 24, 25, 27, 29, 31], "Then": 27, "There": [4, 23, 27], "These": [4, 5, 12, 14, 20, 22, 30], "To": [2, 4, 16, 17, 22, 23, 26, 27, 29, 31, 32, 33, 39], "With": [3, 5, 32, 33], "__add__": [3, 5], "__aiter__": [5, 12], "__and__": [3, 5], "__anext__": [5, 12], "__arrow_c_array__": [1, 33], "__arrow_c_stream__": [1, 2, 33], "__call__": [5, 14], "__datafusion_table_provider__": [1, 16, 39], "__eq__": [3, 5], "__ge__": [3, 5], "__getitem__": [2, 3, 5], "__gt__": [3, 5], "__init__": [5, 14, 27], "__invert__": [3, 5], "__iter__": [5, 12], "__le__": [3, 5], "__lt__": [3, 5], "__mod__": [3, 5], "__mul__": [3, 5], "__ne__": [3, 5], "__next__": [5, 12], "__or__": [3, 5], "__radd__": [3, 5], "__rand__": [3, 5], "__repr__": [2, 3, 5, 11], "__richcmp__": [3, 5], "__rmod__": [3, 5], "__rmul__": [3, 5], "__ror__": [3, 5], "__rsub__": [3, 5], "__rtruediv__": [3, 5], "__str__": 14, "__sub__": [3, 5], "__truediv__": [3, 5], "__version__": 32, "_aggreg": 4, "_create_window_udf": [5, 14], "_create_window_udf_decor": [5, 14], "_get_default_nam": [5, 14], "_intern": [0, 2, 3, 5, 11, 12, 13], "_normalize_input_typ": [5, 14], "_null_treat": 3, "_order_bi": 3, "_partition_bi": 3, "_r": [5, 14], "_raw_plan": [5, 11], "_repr_html_": 2, "_sum": [5, 14, 27], "_to_pyarrow_typ": [3, 5], "_udaf": [5, 14], "_udf": [5, 14], "_udwf": [5, 14], "_window_fram": 3, "_window_funct": 4, "a0": 22, "a_siz": 22, "ab": 4, "abc": 6, "abi": 16, "abi3": 17, "abi_st": 16, "abil": 31, "abilti": 31, "abl": [5, 11], "about": [13, 16, 18, 29, 30], "abov": [4, 16, 20, 29], "absolut": 4, "abstract": [5, 6, 14, 22, 27], "accept": [1, 3, 5, 33], "access": [5, 9, 16, 22, 31], "access_key_id": 31, "account": 31, "accum": [5, 14], "accumul": [5, 14, 27], "achiev": 18, "aco": 4, "acosh": 4, "acronym": 16, "across": [14, 16, 22], "act": [5, 11], "activ": [16, 17], "actual": 2, "ad": 2, "adapt": 16, "add": [1, 2, 3, 4, 16, 17], "add_3": 2, "addit": [2, 3, 4, 5, 13, 14, 16, 17, 27, 31], "addition": [16, 19], "adhoc": 17, "adopt": 16, "advanc": 31, "advantag": [16, 17, 18], "affect": [14, 20], "after": [2, 4, 14, 27], "ag": 22, "against": [1, 3, 4, 14, 16, 18, 28], "age_col": 22, "age_in_year": 22, "agg": 2, "aggreg": [1, 2, 3, 4, 5, 14, 19, 24], "aggregatefunct": 3, "aggregateudf": [1, 5, 14], "aim": 32, "albert": 22, "algorithm": [2, 4], "alia": [1, 2, 3, 4, 5, 19, 20, 22, 23, 26, 27, 29, 33], "alias": 17, "alic": 25, "all": [0, 1, 2, 4, 5, 14, 16, 17, 19, 20, 23, 25, 26, 27, 29, 31], "alloc": 2, "allow": [1, 5, 14, 16, 17, 18, 20, 22, 23, 27], "alpha": [27, 31], "alreadi": [4, 16], "also": [1, 2, 5, 14, 16, 17, 18, 20, 22, 23, 27, 29, 32, 40], "altern": [26, 35, 38], "alternate_a": 2, "alwai": 14, "amazons3": [10, 31], "amount": [2, 14], "an": [1, 2, 3, 4, 5, 9, 11, 13, 14, 16, 17, 19, 20, 21, 22, 25, 26, 27, 29, 31, 32, 33, 34, 35, 38], "analyt": 29, "analyz": [2, 3, 17], "ani": [1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 16, 20, 25, 27, 29, 31, 33], "anoth": [2, 4, 5, 9, 16], "anti": [2, 24], "apach": [1, 3, 4, 5, 16, 17, 18, 33], "apart": 18, "api": [1, 5, 11, 16, 17, 18, 23, 29, 30, 40], "appear": [3, 4, 5, 16], "append": [4, 27], "appli": 2, "applic": 16, "approach": [4, 20, 22], "appropri": [14, 17, 31], "approx_distinct": [4, 20], "approx_median": [4, 20], "approx_percentile_cont": [4, 20], "approx_percentile_cont_with_weight": [4, 20], "approxim": [4, 20], "ar": [1, 2, 3, 4, 5, 9, 11, 12, 14, 16, 17, 19, 20, 22, 24, 26, 27, 29, 31, 32, 33], "arbitrari": [2, 4], "arc": [4, 16, 39], "area": 16, "arg": [1, 2, 4, 5, 13, 14, 17], "argument": [2, 4, 5, 14, 20, 27], "around": [4, 17], "arrai": [1, 2, 3, 4, 5, 14, 20, 24, 27, 31, 33], "array1": 4, "array2": 4, "array_agg": [4, 20], "array_append": [4, 17], "array_cat": [4, 22], "array_concat": [4, 22], "array_dim": 4, "array_distinct": 4, "array_el": [3, 4, 5, 22], "array_empti": [4, 22], "array_except": 4, "array_extract": 4, "array_ha": 4, "array_has_al": 4, "array_has_ani": 4, "array_indexof": 4, "array_intersect": 4, "array_join": 4, "array_length": 4, "array_ndim": 4, "array_pop_back": 4, "array_pop_front": 4, "array_posit": 4, "array_prepend": 4, "array_push_back": 4, "array_push_front": 4, "array_remov": 4, "array_remove_al": 4, "array_remove_n": 4, "array_repeat": [4, 22], "array_replac": 4, "array_replace_al": 4, "array_replace_n": 4, "array_res": 4, "array_slic": 4, "array_sort": 4, "array_to_str": 4, "array_union": 4, "arrow": [1, 2, 3, 4, 5, 17, 18, 21, 31, 32, 36], "arrow_cast": [3, 4, 5, 23], "arrow_datafusion_python_root": 17, "arrow_typeof": 4, "arrowarrayexport": 1, "arrowstreamexport": 1, "arxiv": 4, "as_pi": [5, 14, 27], "ascend": [3, 4, 5, 20, 29], "ascii": 4, "asin": 4, "asinh": 4, "assembl": 1, "assign": [3, 4, 5], "assist": 17, "associ": [0, 1, 3, 4, 5, 16], "assum": [2, 4, 17, 31], "assumpt": 18, "async": [5, 12], "atan": 4, "atan2": 4, "atanh": 4, "atk": [18, 31, 32], "attack": [18, 20, 23, 29, 31, 32, 40], "attempt": [1, 2, 5, 14, 16, 17], "auto": 15, "autoapi": 15, "automat": [1, 5], "avail": [2, 20, 24, 27, 30, 39], "availbl": 29, "averag": [4, 14, 29], "avg": [4, 14, 20, 29], "avoid": [1, 5, 9], "avro": [1, 5, 9, 31, 36], "awar": [2, 26], "aws_access_key_id": 31, "aws_secret_access_kei": 31, "b": [2, 4, 21, 22, 27, 28, 31, 33], "back": [3, 16, 18, 33], "bar": 30, "base": [1, 2, 3, 4, 5, 7, 8, 9, 14, 15, 22, 25, 27], "base64": 4, "baseinputsourc": [6, 7, 8], "basi": [5, 14, 27], "basic": [19, 24, 26, 27], "basic_typ": 23, "batch": [1, 2, 5, 11, 12, 14, 21, 27, 28, 31, 33], "batch_arrai": 27, "batch_siz": [1, 5], "becaus": [3, 5, 27], "becca": 22, "beedril": [18, 29, 31, 32], "beedrillmega": [18, 29, 31, 32], "been": 16, "befor": [4, 17, 22, 27], "beforehand": [1, 5], "begin": [1, 3, 4, 5, 14], "beginnig": 4, "being": 2, "below": [19, 20, 31], "best": [1, 5, 16], "beta": 31, "better": 2, "between": [1, 3, 4, 5, 14, 16, 18, 19, 25, 27, 29], "betwen": 29, "bia": [5, 14], "bias_10": [5, 14], "biased_numb": [5, 14], "biasednumb": [5, 14], "bin": [4, 17], "binari": [3, 4, 5, 11, 16], "binaryexpr": [3, 5], "bind": [5, 18, 32], "bit": 4, "bit_and": [4, 20], "bit_length": 4, "bit_or": [4, 20], "bit_xor": [4, 20], "bitwis": [4, 22], "blake2": 4, "blake2b": 4, "blake3": 4, "blastois": [18, 31, 32], "blastoisemega": [18, 31, 32], "blob": [3, 5], "blog": 17, "blue": 22, "bob": 25, "bool": [1, 2, 3, 4, 5, 6, 7, 8, 9, 14], "bool_": 27, "bool_and": [4, 20], "bool_or": [4, 20], "boolean": [4, 24], "bootstrap": 17, "both": [2, 4, 5, 14, 16, 17, 22, 25], "bound": [3, 5, 14, 29, 39], "boundari": [14, 16, 29], "bow": 29, "box": 16, "bracket": 22, "break": 16, "bronz": 4, "brotli": 2, "btrim": 4, "bucket_nam": 31, "bug": [18, 20, 29, 31, 32], "build": [3, 4, 5, 16, 18, 19, 20, 29], "build_flag": 17, "build_tabl": [6, 7, 8], "builder": [3, 4, 20, 29], "built": [14, 16, 20, 22, 23, 27], "bulb": 23, "bulbafleur": 23, "bulbasaur": [18, 23, 29, 31, 32], "bulk": 16, "butterfre": [18, 29, 31, 32], "byte": [1, 4, 5, 11, 13], "c": [1, 2, 14, 16, 17, 18, 21, 31, 33], "cach": 2, "calcul": [2, 4, 14, 27], "call": [0, 1, 2, 3, 4, 5, 11, 12, 13, 14, 16, 19, 20, 22, 27, 33], "callabl": [2, 5, 14], "calll": 22, "can": [1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 14, 16, 17, 19, 20, 22, 26, 27, 28, 29, 30, 31, 32, 33, 39], "can_retir": 22, "cannot": 4, "canon": 16, "canonical_nam": [3, 5], "capit": [4, 26], "capsul": 16, "cardin": [4, 22], "carefulli": 16, "cargo": 17, "carlo": 22, "case": [2, 3, 4, 5, 14, 16, 20, 23, 26, 27, 29, 31], "case_build": 3, "casebuild": [3, 4], "cast": [2, 3, 4, 5, 24], "castabl": [3, 5], "catalog": [1, 5, 15], "caterpi": [18, 29, 31, 32], "caus": [1, 5, 17, 29, 33], "cbrt": 4, "cdatainterfac": 1, "ceil": 4, "certain": 14, "certainli": 17, "chain": 2, "challeng": 16, "chang": [14, 17, 22], "chansei": 20, "char": 23, "char_length": [4, 23], "charact": 4, "character_length": 4, "charizard": [18, 23, 29, 31, 32], "charizardmega": [18, 23, 29, 31, 32], "charli": 25, "charmand": [18, 23, 29, 31, 32], "charmeleon": [18, 23, 29, 31, 32], "check": [4, 22, 23], "checksum": 4, "children": [5, 11], "chr": 4, "chrono": 4, "ci": [16, 17], "citycab": 25, "class": 27, "classmethod": [1, 2], "classvar": [3, 5], "claus": [14, 29], "clean": 17, "clefabl": 29, "clefairi": [20, 29], "clone": [17, 39], "close": 29, "co": 4, "coalesc": [4, 23], "code": [4, 16, 23], "codebas": 17, "coeffici": 4, "coerc": 4, "col": [2, 3, 4, 5, 14, 19, 20, 22, 23, 26, 27, 28, 29, 33, 40], "col1": 14, "col_attack": 20, "col_diff": 27, "col_spe": 20, "col_type_1": 20, "col_type_2": 20, "collect": [2, 18, 19, 21, 28, 33, 40], "collect_partit": 2, "color": 22, "column": [1, 2, 3, 4, 5, 9, 14, 19, 20, 21, 23, 24, 25, 27, 29, 40], "column_a": 3, "column_nam": [3, 5], "com": [3, 4, 5, 17], "combin": [2, 4, 22, 25, 26, 27], "come": [31, 37], "command": [1, 5, 17], "common": [3, 4, 5, 6, 7, 8, 20, 23, 25, 29, 33], "commun": [16, 17], "compar": [4, 29], "comparison": [3, 5, 20], "compat": [16, 22], "compil": [16, 22], "complet": [3, 4, 5, 6, 16, 17, 27, 39], "complex": [2, 18, 23], "complic": 2, "compon": 4, "compos": 4, "compress": [1, 2, 5, 9], "compression_level": 2, "comput": [2, 3, 4, 5, 14, 16, 22, 27], "concat": 4, "concat_w": 4, "concaten": [4, 22], "concatenated_arrai": 22, "concept": [1, 2, 3, 5, 22], "concis": 17, "concurr": [1, 5], "condit": 24, "config": [1, 5, 17, 30], "config_intern": [1, 5], "config_opt": [1, 5], "configur": [1, 5, 17], "conflict": [1, 5, 9], "conjunct": 2, "connect": [1, 19], "consecut": 4, "consid": 4, "consist": 4, "consol": 2, "construct": [3, 5, 14, 27], "constructor": [0, 2, 3, 5, 11, 12, 13, 14], "consum": [6, 13, 33], "contain": [2, 4, 5, 11, 14, 15, 16, 17, 20, 22, 25, 27], "content": [17, 24], "context": [4, 5, 9, 11, 13, 15, 28, 30, 33, 40], "continu": [4, 16], "contribut": 17, "control": [1, 5, 20, 29], "conveni": [5, 14, 31], "convent": 16, "convers": [16, 17], "convert": [1, 2, 3, 4, 5, 11, 12, 13, 14, 16, 19, 21, 22, 23, 27, 28, 40], "copi": [16, 17, 18, 27, 33], "core": [2, 3, 5, 16], "corr": [4, 20], "correctli": [2, 14], "correl": 4, "correspond": [4, 25], "cosh": 4, "cosin": 4, "cost": 18, "costli": 14, "cot": 4, "cotang": 4, "could": [2, 3, 5, 16], "count": [2, 4, 20, 21], "count_star": 4, "counterpart": [4, 16], "coupl": [16, 29], "covar": 4, "covar_pop": [4, 20], "covar_samp": [4, 20], "covari": 4, "cover": [19, 23, 30], "cpython": 17, "crate": 16, "creat": [1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 13, 14, 15, 16, 17, 19, 20, 22, 28, 30, 33, 40], "create_datafram": [1, 27, 31], "create_dataframe_from_logical_plan": 1, "creatememoryt": 3, "createview": 3, "credenti": 31, "criteria": [4, 29], "cstream": 16, "cstring": [16, 39], "csv": [1, 2, 5, 9, 16, 18, 20, 23, 29, 31, 32, 36, 40], "ctx": [1, 4, 5, 11, 13, 18, 19, 20, 21, 22, 23, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 38, 39, 40], "cube": 4, "cubon": 20, "cume_dist": [4, 14, 29], "cumul": 4, "curr_valu": 27, "current": [2, 3, 4, 5, 11, 14, 16, 23, 27, 29], "current_d": 4, "current_tim": 4, "custom": [1, 5, 6, 11, 16, 25, 27, 36], "customer_id": 25, "d": [2, 14, 33], "dai": [4, 23], "dant": 22, "dark": 20, "data": [0, 1, 2, 3, 4, 5, 9, 11, 14, 16, 17, 18, 19, 20, 21, 22, 23, 26, 27, 28, 29, 32, 33, 34, 37, 39], "data_typ": 4, "databas": [0, 5, 22], "dataflow": [5, 11], "datafram": [1, 3, 4, 5, 9, 11, 12, 14, 15, 18, 20, 21, 22, 23, 25, 26, 27, 28, 29, 32, 33, 40], "datafrm": 2, "datafus": [15, 16, 17, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 34, 35, 36, 37, 38, 39, 40], "datafusion_df": 31, "datafusion_table_provid": [16, 39], "dataset": [1, 23, 29, 31, 32], "datasourc": 6, "datastructur": [3, 5], "datatyp": [2, 3, 5, 14], "datatypemap": [3, 5], "date": [4, 23], "date32": 4, "date_bin": 4, "date_part": [4, 23], "date_trunc": 4, "datepart": 4, "datetrunc": 4, "db": [0, 5], "ddl": [1, 5], "decid": [14, 16], "decim": 4, "decimal_plac": 4, "decod": 4, "decor": [5, 14], "def": [2, 5, 14, 18, 27, 31, 32], "default": [1, 2, 3, 4, 5, 8, 9, 14, 16, 17, 27, 29, 30], "default_valu": 4, "defens": [18, 23, 31, 32, 40], "defin": [1, 3, 5, 14, 16, 17, 23, 24, 29], "definit": [1, 3, 5, 14, 16, 19, 27], "degre": 4, "delet": [1, 5], "delimit": [1, 4, 5, 9], "delta": 16, "delta_t": 31, "deltalak": 31, "deltat": 31, "demonstr": [1, 27, 29, 32, 33], "dens": 4, "dense_rank": [4, 14, 29], "depend": [4, 16, 20, 27, 29], "deprec": [2, 4, 29], "deregister_t": 1, "descend": 4, "describ": [2, 4, 16, 19, 20, 21, 31], "descript": [4, 5, 14], "deseri": 13, "deserialize_byt": 13, "design": [16, 24], "desir": 4, "detafram": 1, "detail": [2, 3, 4, 5, 14, 17, 21], "determin": [2, 3, 4, 5, 27], "dev": 17, "develop": 16, "deviat": 4, "df": [1, 2, 3, 4, 18, 19, 20, 21, 22, 23, 26, 27, 28, 29, 31, 32, 33, 34, 35, 37, 38, 40], "df_filter": 28, "df_view": 28, "dfschema": 5, "dict": [1, 2, 3, 5], "dictionari": [1, 2, 22, 28, 31], "differ": [2, 3, 4, 5, 11, 14, 16, 23, 27, 31], "difficult": 16, "digest": 4, "dimens": 4, "dimension": 2, "directli": [3, 4, 13, 31, 33], "directori": [1, 5, 17], "disabl": [1, 5], "discard": 2, "discuss": 16, "disk": [1, 5, 7, 8], "displai": [5, 11, 19, 21, 28, 32], "display_graphviz": [5, 11], "display_ind": [5, 11], "display_indent_schema": [5, 11], "display_nam": [3, 5], "distanc": 4, "distinct": [2, 3, 4, 5], "distinctli": 16, "distinguish": 16, "distribut": 4, "divid": 4, "divis": [3, 4, 5], "divisor": 4, "dml": [1, 5], "do": [1, 5, 14, 16, 17, 19, 20, 27, 29, 31, 39], "doc": [1, 4], "docstr": 17, "document": [1, 2, 3, 4, 5, 15, 16, 17, 19, 30, 32], "doe": [2, 4, 14, 16, 17, 29, 31], "doesn": 14, "dominant_typ": 23, "done": [2, 20, 27], "dot": [5, 11], "doubl": [26, 33], "double_func": [5, 14], "double_it": [5, 14], "double_udf": [5, 14], "down": [16, 29, 31], "downcast": 16, "download": [26, 32], "dragon": [18, 20, 23, 29, 31, 32], "dragonair": 29, "dratini": 29, "drop": [1, 2, 5], "droptabl": 3, "dtype": 2, "due": [1, 5, 9, 17], "duplic": [2, 4, 25], "dure": [5, 14, 17], "dynamic_lookup": 17, "e": [2, 4, 14, 27, 39], "each": [2, 3, 4, 5, 14, 16, 17, 20, 29], "earli": 16, "easi": [16, 37], "easier": [16, 23, 32], "easili": [3, 5, 16], "east": 31, "effect": [26, 32], "effort": 16, "either": [1, 2, 3, 5, 14, 16, 20], "electr": [20, 29], "element": [2, 3, 4, 5, 22], "ellipsi": [2, 5, 14], "els": 27, "else_expr": 3, "employe": 22, "empti": [1, 4, 5, 11, 20, 22], "empty_t": 1, "emptyrel": 3, "enabl": [1, 5, 16], "enable_url_t": 1, "encod": [4, 13], "encourag": 17, "end": [0, 2, 3, 4, 5, 11, 12, 14, 29], "end_bound": [3, 5], "ends_with": 4, "engin": [1, 5, 18, 19], "enough": 14, "ensur": 6, "entir": [14, 20, 27, 29], "entri": [2, 4, 20, 29], "enum": [2, 3, 5, 14], "enumer": 14, "enviorn": 17, "environ": [17, 18], "equal": [2, 3, 4, 5], "equival": [4, 14, 16, 20, 29], "error": [1, 3, 5, 17], "especi": 17, "essenti": [5, 12, 21], "etc": [1, 3, 5, 7, 8, 14], "eval_rang": 14, "evalu": [2, 3, 4, 5, 14, 19, 20, 22, 27, 29], "evaluate_al": [5, 14, 27], "evaluate_all_with_rank": [14, 27], "even": [1, 5, 16, 25], "everi": [4, 5, 14], "everyth": [7, 8], "ex": [3, 5, 26], "exact": 16, "exactli": [2, 29], "examin": [3, 5], "exampl": [1, 2, 3, 4, 5, 11, 14, 16, 19, 20, 22, 23, 25, 27, 28, 29, 31, 32, 39], "excel": 16, "except": [2, 3, 4, 5, 22], "except_al": 2, "exclud": [2, 25], "execut": [1, 2, 5, 14, 17, 18, 19, 30, 33], "execute_stream": [2, 5, 12], "execute_stream_partit": 2, "execution_plan": 2, "executionplan": [1, 2, 5, 11], "exeggcut": 20, "exist": [1, 2, 3, 4, 5, 16], "exp": 4, "exp_smooth": 27, "expand": 2, "expect": [3, 4, 5, 14, 16, 22, 27, 29], "expens": 2, "experi": 17, "explain": [2, 3], "explan": [2, 19], "explicit": 30, "explicitli": [5, 14], "expon": 4, "exponenti": 4, "exponentialsmooth": 27, "export": [1, 2, 16, 17, 36], "expos": [1, 16, 31, 39], "expr": [1, 2, 4, 5, 9, 14, 15, 29], "expr1": 4, "expr2": 4, "express": [2, 3, 4, 5, 14, 20, 23, 24, 27, 29], "exprfuncbuild": [3, 5], "extend": [4, 6, 16], "extens": [1, 3, 5, 9], "extract": [3, 4, 5, 23], "extraenv": 17, "f": [3, 19, 20, 22, 23, 29, 31], "face": 16, "fact": [16, 27], "factori": [4, 5, 14], "fail": 17, "fair": [1, 5], "fairi": [20, 29], "fals": [2, 3, 4, 5, 14, 16, 17, 18, 22, 23, 26, 27, 30, 31, 32, 39], "familiar": 17, "far": 2, "faster": [4, 14], "featur": [4, 16, 17, 31, 33], "fetch": 17, "few": [16, 17, 19], "ffi": 31, "ffi_": 16, "ffi_provid": 16, "ffi_tableprovid": [1, 16, 39], "field": [2, 4, 23], "fight": [20, 29], "file": [1, 2, 5, 7, 8, 9, 13, 16, 17, 18, 19, 26, 32, 34, 35, 37, 38], "file_compression_typ": [1, 5, 9], "file_extens": [1, 5, 9], "file_partition_col": [1, 5, 9], "file_sort_ord": [1, 5, 9], "filenam": 17, "fill": [3, 4, 5, 29], "fill_nan": [3, 5], "fill_nul": [3, 5], "filter": [2, 3, 4, 5, 11, 19, 22, 28, 29, 31], "final": [19, 27], "find": [4, 16, 17, 19, 20, 29], "find_in_set": 4, "finish": [3, 20], "fire": [18, 20, 23, 31, 32], "first": [1, 2, 3, 4, 5, 16, 17, 19, 20, 22, 29, 32], "first_1": 20, "first_2": 20, "first_arrai": 4, "first_valu": [4, 14, 20], "fix": 14, "flag": [4, 14, 17], "flatten": 4, "fleur": 23, "float": [3, 4, 5, 14, 27], "float64": [5, 14, 23, 27], "floor": 4, "flow": [5, 11], "flower": 23, "fly": [18, 20, 29, 31, 32], "fn": 39, "focus": 16, "folder": [16, 39], "follow": [1, 2, 3, 4, 5, 14, 16, 17, 19, 20, 22, 23, 25, 27, 29, 31, 32], "foo": 30, "fora": [3, 5], "foreign": 16, "foreign_provid": 16, "foreigntableprovid": 16, "form": [2, 4, 5, 11, 20], "format": [1, 2, 4, 5, 11, 31, 34, 37], "format_argu": 4, "formatt": 4, "forth": 33, "found": [4, 17, 29, 39], "four": 27, "frame": [3, 4, 5, 14, 21, 27], "frame_bound": 3, "framework": 17, "free": [1, 5], "frequent": [16, 17], "from": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 13, 14, 17, 18, 19, 20, 21, 22, 23, 25, 26, 27, 28, 29, 30, 31, 32, 34, 35, 36, 37, 38, 40], "from_arrai": [27, 31], "from_arrow": [1, 31, 33], "from_arrow_t": 1, "from_panda": 1, "from_polar": [1, 31], "from_proto": [5, 11], "from_pydict": [1, 21, 22, 25, 27, 28, 31, 33], "from_pylist": [1, 25, 31], "from_str": 2, "from_substrait_plan": 13, "from_unixtim": 4, "from_val": 4, "fuction": 14, "full": [2, 4, 24, 40], "fulli": 17, "func": [2, 5, 14], "function": [1, 2, 3, 10, 12, 14, 15, 16, 19, 21, 24, 31, 38], "function_to_impl": [14, 27], "further": 16, "futher": 4, "futur": [14, 29], "g": [4, 14], "gamma": 31, "gcd": 4, "gener": [3, 5, 11, 12, 13, 14, 15, 16, 17, 18, 31, 32], "geodud": 29, "get": [2, 5, 11, 14, 17, 22, 31], "get_default_level": 2, "get_frame_unit": [3, 5], "get_lower_bound": [3, 5], "get_offset": 3, "get_rang": 14, "get_upper_bound": [3, 5], "getenv": 31, "ghost": 20, "gil": 18, "git": 17, "github": [3, 4, 5, 17], "give": [4, 20, 26, 32], "given": [0, 1, 3, 4, 5, 14, 27], "glanc": 16, "global": [1, 5, 9], "global_ctx": 1, "go": [16, 21, 23], "goe": 16, "gold": 4, "good": [16, 17], "googlecloud": [10, 31], "graph": [5, 11], "graphic": [5, 11], "graphviz": [5, 11], "grass": [18, 20, 23, 29, 31, 32], "great": 17, "greater": [3, 4, 5], "greatest": 4, "greatli": 27, "greedi": [1, 5], "green": 22, "grimer": 29, "ground": 20, "group": [1, 2, 3, 4, 5, 9, 14, 19, 20, 21, 29], "group_bi": [2, 20], "groupingset": 3, "guarante": 16, "guid": [1, 24, 30, 32], "gzip": 2, "ha": [1, 2, 4, 5, 14, 16, 22, 26, 31], "handl": [12, 20, 29], "happen": [17, 33], "has_head": [1, 5, 9], "hash": [2, 4], "haskel": 21, "have": [1, 2, 4, 5, 9, 13, 14, 16, 17, 18, 20, 25, 27, 29, 39], "head": 2, "header": [1, 2, 5, 9], "healthi": 17, "heavy_red_unit": 22, "help": [1, 5, 9, 17, 22, 23], "helper": [5, 14], "henc": 14, "here": [4, 16, 23, 26, 29, 32, 33, 40], "hex": 4, "hexadecim": 4, "high": [3, 5], "higher": [2, 3, 5], "highli": 27, "highlight": 32, "hint": [1, 17], "homebrew": 17, "host": 1, "how": [1, 2, 3, 4, 5, 14, 16, 20, 21, 24, 25, 27, 29, 30, 32], "howev": [14, 27], "hp": [18, 31, 32], "html": [1, 4], "http": [1, 3, 4, 5, 10, 11, 13, 31], "hyperbol": 4, "i": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 14, 16, 17, 18, 19, 20, 22, 23, 25, 27, 29, 31, 32, 33, 34, 35, 37, 38], "ic": 20, "id": [1, 17, 25], "ideal": 16, "ident": 31, "identifi": [1, 3, 5, 16, 26], "idx": [14, 27], "ignor": [4, 17, 20, 29], "ignore_nul": [20, 29], "ilik": 3, "immut": [5, 14, 27], "impl": 39, "implement": [1, 2, 14, 17, 27, 31, 33, 39], "import": [1, 3, 5, 14, 16, 18, 19, 20, 21, 22, 23, 25, 26, 27, 28, 29, 30, 31, 32, 34, 35, 36, 37, 38, 40], "improv": [1, 5, 14, 27], "in_list": [4, 23], "includ": [1, 2, 3, 5, 16, 20, 23, 25], "include_rank": [14, 27], "inclus": [1, 3, 4, 5], "incorpor": 27, "increas": [1, 5, 20], "increment": [14, 16, 27], "indent": [5, 11], "independ": [4, 29], "index": [3, 4, 5, 14, 22], "indic": [3, 4, 22], "individu": [22, 29], "infer": [1, 5, 9], "inform": [1, 2, 3, 5, 6, 13, 16, 27], "information_schema": [1, 5], "init": 17, "initcap": 4, "initi": 4, "inlin": 14, "inlist": 3, "inner": [2, 24], "input": [1, 2, 4, 5, 9, 11, 14, 15, 22, 27], "input_item": [6, 7, 8], "input_typ": [5, 14], "inputsourc": 6, "insert": [1, 5], "instanc": [1, 4, 5, 14, 19], "instanti": [5, 14], "instead": [3, 4, 5, 16], "insubqueri": 3, "int": [1, 2, 3, 4, 5, 9, 11, 14, 27], "int32": [5, 14, 23], "int64": [5, 14, 21, 23, 27], "integ": [3, 4, 5, 22], "integr": [16, 32, 39], "intend": 16, "interact": [16, 22], "intercept": 4, "interchang": 37, "interest": 22, "interfac": [1, 4, 16, 18, 19, 27, 29, 31, 33, 39], "intermedi": [5, 14], "intern": 27, "intersect": [2, 4], "interv": 4, "into_view": 2, "intro": 17, "introduc": [17, 19], "introduct": 19, "intuit": 16, "invers": 4, "invoc": 14, "io": [1, 5, 13, 15], "is_caus": 14, "is_correct_input": [6, 7, 8], "is_current_row": 3, "is_empti": 22, "is_follow": 3, "is_not_nul": [3, 5, 20], "is_nul": [3, 5, 27], "is_null_arr": 27, "is_preced": 3, "is_unbound": 3, "isfals": 3, "isnan": 4, "isnotfals": 3, "isnotnul": [3, 5], "isnottru": 3, "isnotunknown": 3, "isnul": 3, "issu": [4, 17, 29], "istru": 3, "isunknown": 3, "iszero": 4, "iter": [2, 5, 12], "iterat": 2, "its": [2, 4, 5, 11, 14, 16, 18, 29], "itself": 22, "ivi": 23, "ivyfleur": 23, "ivysaur": [18, 23, 29, 31, 32], "java": 21, "javascript": 37, "jigglypuff": 29, "join": [1, 2, 3, 5, 11, 24], "join_kei": [2, 25], "join_on": 2, "joinconstraint": 3, "jointyp": 3, "json": [1, 2, 5, 9, 31, 36], "jupyt": 32, "jupyterlab": 32, "jynx": 20, "kakuna": [18, 29, 31, 32], "keep": [17, 28], "kei": [1, 2, 3, 5, 16, 19, 22, 25], "kind": [0, 5, 16, 17], "know": [1, 5], "known": 22, "kwarg": [6, 7, 8], "kwd": [2, 14], "l179": [3, 5], "lab": 32, "label": 2, "lack": 18, "lag": [4, 14, 29], "lambda": [5, 14], "languag": [1, 5, 11, 16], "larg": [2, 23], "large_trip_dist": 26, "last": [4, 29], "last_valu": [4, 20, 29], "last_with_nul": 29, "last_wo_nul": 29, "later": [31, 32, 39], "latest": [4, 16], "latter": 1, "lazi": 19, "lcm": 4, "lead": [4, 14, 16, 27, 29, 31], "leaf": [5, 11], "leak": 18, "learn": [16, 21, 29], "least": [4, 14, 20, 25, 27], "leav": [5, 11], "left": [2, 4, 23, 24], "left_on": [2, 25], "leftmost": 4, "legendari": [18, 31, 32], "len": [14, 23], "length": [4, 5, 14], "less": [3, 4, 5], "lesson": 16, "let": [16, 30, 39], "letter": [4, 26], "level": [2, 4, 16], "levenshtein": 4, "leverag": 16, "lib": 17, "lib_dir": 17, "lib_nam": 17, "librari": [5, 6, 16, 18, 32, 33, 39], "lightweight": 37, "like": [1, 3, 4, 5, 6, 16, 17, 18, 23], "limit": [2, 3, 4, 17, 19, 21, 23], "line": [1, 2, 5, 9, 11, 16], "linear": [4, 20], "link": [17, 29], "lint": 17, "linter": 17, "list": [0, 1, 2, 3, 4, 5, 9, 11, 14, 20, 27, 28, 29, 31], "list_append": [4, 17], "list_cat": 4, "list_concat": 4, "list_dim": 4, "list_distinct": 4, "list_el": 4, "list_except": 4, "list_extract": 4, "list_indexof": 4, "list_intersect": 4, "list_join": 4, "list_length": 4, "list_ndim": 4, "list_posit": 4, "list_prepend": 4, "list_push_back": 4, "list_push_front": 4, "list_remov": 4, "list_remove_al": 4, "list_remove_n": 4, "list_repeat": 4, "list_replac": 4, "list_replace_al": 4, "list_replace_n": 4, "list_res": 4, "list_slic": 4, "list_sort": 4, "list_to_str": 4, "list_union": 4, "listingt": 1, "lit": [2, 3, 4, 5, 17, 19, 20, 22, 26, 29, 33], "liter": [2, 3, 5, 23, 24, 26, 28], "ll": [23, 25, 29], "ln": 4, "local": [1, 16, 17], "localfilesystem": [10, 31], "locat": [1, 7, 15], "locationinputplugin": [7, 8], "lock": 18, "log": [4, 23], "log10": 4, "log2": 4, "logarithm": 4, "logic": [1, 2, 3, 5, 11, 13, 19, 20, 26], "logical_plan": [2, 13], "logicalplan": [1, 2, 3, 5, 11, 13], "lonely_trip": 26, "long": 16, "long_tim": 22, "longer": 4, "look": [17, 30], "low": [3, 5, 20], "low_passenger_count": 26, "lower": [3, 4, 5, 14, 23, 26], "lowercas": [2, 4], "lowest": [16, 20], "lpad": 4, "ltrim": 4, "lz4": 2, "lz4_raw": 2, "lzo": 2, "m": 17, "mac": 17, "machin": 17, "machop": 29, "made": 26, "magikarp": 20, "magnemit": 29, "mai": [1, 2, 4, 5, 9, 14, 16, 27, 31, 32, 33], "main": [1, 19], "maintain": [1, 2, 16, 19], "major": [17, 18], "make": [4, 16, 17, 18, 23], "make_arrai": 4, "make_d": 4, "make_list": 4, "manag": [1, 5, 17], "mani": [16, 20, 27], "manipul": [1, 5, 23], "mankei": 29, "manner": 16, "manual": 17, "map": 2, "map_err": 39, "match": [2, 3, 4, 25], "math": 20, "mathemat": [24, 26], "maturin": 17, "max": [4, 20, 21], "maximum": [1, 4, 5, 9], "md5": 4, "mean": [4, 16, 17, 21], "meaning": [4, 26], "meant": [5, 11], "medal": 4, "median": [4, 20, 21], "member": 17, "memoiz": 14, "memori": [1, 2, 5, 11, 14, 18], "mention": 22, "merg": [5, 14, 25, 27], "metadata": [1, 5, 9], "metapod": [18, 20, 29, 31, 32], "method": [1, 2, 4, 5, 14, 19, 21, 25, 27, 28], "metric": 2, "metrorid": 25, "microsecond": 4, "microsoftazur": [10, 31], "might": [14, 20], "millisecond": 4, "min": [4, 20, 21], "minimum": [1, 4, 5], "model": 2, "modifi": [2, 19], "modify_df": 2, "modul": 29, "modulo": [3, 5], "moment": [2, 16], "month": [4, 23], "more": [1, 2, 3, 5, 13, 16, 17, 20, 23, 27, 30], "most": [14, 16, 22, 29, 32], "mostli": 17, "much": [14, 17], "multi": 18, "multipl": [1, 2, 3, 4, 5, 14, 20, 23, 25, 27, 29, 31], "must": [1, 2, 3, 4, 5, 14, 20, 22, 26, 27, 29, 33, 39], "my_capsul": 16, "my_delta_t": 31, "my_provid": 16, "my_tabl": [28, 39], "my_udaf": 27, "myaccumul": 27, "mytableprovid": [16, 39], "myusernam": 17, "n": [2, 4], "name": [0, 1, 2, 3, 4, 5, 9, 14, 16, 18, 19, 20, 21, 22, 23, 25, 26, 27, 29, 31, 32, 39], "name_pair": 4, "named_expr": 2, "named_struct": [4, 17], "nan": [3, 4, 5], "nanosecond": 4, "nanvl": 4, "narrowli": 16, "nativ": 16, "natur": 4, "nearest": 4, "necessari": 16, "need": [1, 2, 3, 5, 9, 14, 16, 17, 27, 29, 32], "neg": [3, 4], "negat": [3, 4, 5, 23], "new": [1, 2, 3, 4, 5, 14, 16, 17, 22, 24, 39, 40], "new_bound": [16, 39], "new_err": 39, "new_nam": 2, "next": [4, 5, 12], "node": [5, 11], "non": [2, 3, 4, 20, 29], "none": [1, 2, 3, 4, 5, 9, 13, 14, 16, 27, 29, 31], "normal": 20, "not_red_unit": 22, "notat": [22, 37], "note": [1, 2, 3, 5, 19, 22, 33], "notebook": 32, "now": [4, 14, 23, 28], "nr": 21, "nth_valu": [4, 14, 20], "ntile": [4, 29], "null": [2, 3, 4, 5, 21, 25, 27, 33], "null_count": 21, "null_first": 4, "null_treat": [3, 4, 5, 20, 29], "nullabl": 2, "nullif": [4, 23], "nulls_first": [3, 4, 5], "nulltreat": [3, 4, 5, 20, 29], "num": [2, 4], "num_centroid": 4, "num_el": 22, "num_row": [5, 14, 27], "number": [1, 2, 4, 5, 9, 11, 14, 17, 22, 23, 29], "numebr": 4, "numer": [2, 4], "nvl": 4, "o": 31, "object": [1, 2, 3, 5, 10, 16, 22, 27, 30, 33, 37], "object_stor": [5, 15, 31], "objectstor": 1, "obtain": [6, 18], "obviou": 16, "occur": [5, 14, 33], "occurr": 4, "octet_length": 4, "oddish": 29, "offend": 17, "offer": [23, 40], "offici": 16, "offset": [2, 3], "often": 29, "old": 2, "old_nam": 2, "older": 31, "olymp": 4, "omit": 25, "on_expr": 2, "onc": [4, 6, 14, 39], "one": [2, 3, 4, 5, 14, 16, 20, 25, 27, 29, 31], "onli": [1, 2, 3, 4, 5, 9, 14, 16, 20, 25, 27, 29], "onlin": [1, 2, 3, 4, 5, 16, 30], "op": [2, 3, 5], "oper": [1, 2, 3, 4, 5, 11, 12, 14, 16, 18, 20, 22, 26, 27, 29, 31, 33], "operand": [3, 5], "opt": 17, "optim": [2, 14, 16], "optimized_logical_plan": 2, "option": [1, 4, 5, 9, 14, 17, 20, 23, 30, 31, 32], "options_intern": [1, 5], "order": [1, 2, 3, 4, 5, 6, 9, 14, 16, 22], "order_bi": [3, 4, 5, 20, 29], "org": [1, 4, 5, 11], "origin": [2, 4, 27], "other": [1, 2, 3, 4, 5, 14, 16, 17, 18, 22, 24], "otherwis": [3, 4], "our": [16, 17, 20, 32], "out": [2, 4, 16, 20, 21, 22, 23, 25, 26, 29, 32, 33, 40], "output": [2, 3, 5, 11, 14, 17, 20, 22, 27, 28], "over": [2, 3, 5, 14, 16, 18, 20, 29], "overhead": 14, "overlai": 4, "overlap": 4, "overrid": 27, "overridden": 20, "own": [6, 27], "pa": [1, 3, 5, 12, 14, 27, 31, 33], "packag": [4, 16, 17], "pad": 4, "page": [15, 16], "pair": 4, "panda": [1, 2, 19, 21, 31, 40], "pandas_df": 31, "para": 29, "parallel": [1, 5], "paramet": [1, 2, 3, 4, 5, 9, 13, 14, 17, 22, 24, 25], "parasect": 29, "parquet": [1, 2, 5, 9, 16, 18, 19, 26, 30, 31, 36], "parquet_prun": [1, 5, 9], "part": [4, 23], "particular": 4, "partit": [1, 2, 3, 4, 5, 9, 11, 14, 20], "partition_bi": [3, 4, 5, 29], "partition_count": [5, 11], "pass": [2, 5, 14, 16, 17, 21, 22, 27, 30, 31], "passenger_count": 26, "path": [1, 2, 5, 9, 13, 17, 31], "path_to_t": 31, "pathlib": [1, 2, 5, 9, 13], "pattern": [4, 16], "pc": [5, 14], "pcre": 4, "pd": 31, "peopl": 4, "per": [2, 14, 29], "percent": 4, "percent_rank": [4, 14, 29], "percentag": 4, "percentil": 4, "perform": [1, 2, 3, 4, 5, 14, 16, 17, 19, 20, 23, 27, 29, 31], "period": 16, "person": 17, "physic": [2, 5, 11, 19], "pi": 4, "pick": 4, "pinsir": 29, "pip": [18, 32], "pl": 31, "place": [4, 17, 32], "placehold": 3, "plan": [1, 2, 3, 5, 13, 14, 15, 18, 19], "plan_intern": 13, "planner": [5, 11], "pleas": 26, "plu": 4, "plugin": [6, 7, 8], "point": [4, 17], "pointer_width": 17, "poison": [18, 20, 29, 31, 32], "pokemon": [18, 19, 20, 23, 29, 31, 32, 40], "polar": [1, 2, 31], "polars_df": 31, "pool": [1, 5], "popul": 4, "popular": [23, 31], "portion": 16, "posit": [4, 20], "possibl": [3, 5, 14, 16, 27, 29], "post": 17, "potenti": [2, 5, 11], "pow": [4, 23], "power": [4, 23, 27, 29], "pr": 17, "practic": 16, "prece": 4, "preced": [3, 5, 14], "preceed": 29, "precis": 4, "predic": [1, 2, 5, 9], "prefer": 17, "prefix": [4, 16], "prepend": 4, "presenc": 23, "present": 25, "preserve_nul": 2, "prevent": 17, "previou": [4, 27, 29], "previous": 1, "primari": [7, 22], "print": [2, 5, 11, 28, 30], "printabl": [5, 11], "prior": [2, 31], "probabl": 20, "process": [14, 20, 29], "produc": [4, 5, 11, 13, 14, 16, 29], "product": 4, "program": 16, "programmat": [5, 11], "project": [2, 3, 5, 11, 16, 17, 33], "properti": [0, 3, 5, 11], "proto_byt": 13, "protobuf": [5, 11], "protocol": 1, "provid": [0, 1, 2, 3, 4, 5, 6, 7, 12, 13, 14, 16, 19, 20, 23, 27, 29, 32, 36], "prune": [1, 5, 9], "psychic": 20, "public": [0, 5], "pull": 17, "pure": 17, "push": [17, 31], "pushdown_filt": 30, "put": 26, "py": [1, 2, 5, 13, 14, 16, 39], "pyarrow": [0, 1, 2, 3, 5, 9, 12, 14, 16, 21, 27, 31, 33, 40], "pycapsul": [1, 2, 16, 31, 33, 39], "pycapsuleinterfac": 1, "pymethod": 39, "pyo3": [16, 17], "pyo3_build_config": 17, "pyo3_config_fil": 17, "pyo3_print_config": 17, "pyobject": [3, 5], "pypi": 32, "pyproject": 17, "pyresult": 39, "pyruntimeerror": 39, "pyspark": 18, "pytabl": 16, "pytest": 17, "python": [1, 3, 5, 14, 21, 22, 27, 31, 32, 33, 39], "python3": 17, "python_valu": [3, 5], "pythontyp": [3, 5], "queri": [1, 5, 11, 13, 14, 16, 18, 19, 23, 28], "quick": 21, "quit": 38, "quot": 26, "r": [2, 3, 4, 5, 16, 17], "radian": 4, "rais": [2, 4], "random": [4, 14, 21, 22], "rang": [1, 2, 3, 4, 5, 14, 21, 22, 23, 27, 29, 30], "rank": [4, 14, 27, 29], "ranks_in_partit": 14, "rather": [4, 13], "ratio": 4, "raw": 3, "raw_sort": 3, "rawexpr": [3, 5], "rb": [5, 12], "re": 16, "read": [1, 5, 7, 8, 9, 13, 16, 30, 31, 32, 34, 35, 37, 38, 40], "read_avro": [1, 5, 9, 34], "read_csv": [1, 5, 9, 18, 19, 20, 29, 31, 32, 35], "read_json": [1, 5, 9, 37], "read_parquet": [1, 5, 9, 19, 26, 38], "read_tabl": 1, "reader": [1, 5, 9, 33], "realiti": 20, "reason": 17, "rebuild": 17, "receiv": [4, 14, 16], "recent": [29, 31], "recommend": [2, 16, 17, 27], "record": [1, 2, 5, 11, 12, 26, 27, 31, 33, 34], "record_batch": [1, 2, 5, 15], "record_batch_stream": [5, 12], "recordbatch": [1, 2, 5, 12, 27, 31], "recordbatchstream": [1, 2, 5, 12], "red": 22, "red_or_green_unit": 22, "red_unit": 22, "reduc": [17, 27], "ref": 4, "refer": [2, 4, 16, 19, 23, 40], "referenc": [1, 19], "regardless": 14, "regener": 17, "regex": 4, "regexp_count": 4, "regexp_lik": 4, "regexp_match": [4, 23], "regexp_replac": [4, 23], "region": 31, "regist": [1, 5, 6, 9, 16, 19, 24, 31, 39, 40], "register_avro": 1, "register_csv": [1, 23, 35, 40], "register_dataset": [1, 31], "register_json": 1, "register_listing_t": 1, "register_object_stor": [1, 31], "register_parquet": [1, 31, 38], "register_record_batch": 1, "register_t": [1, 2], "register_table_provid": [1, 31, 39], "register_udaf": 1, "register_udf": 1, "register_udwf": 1, "register_view": [1, 28], "regr_avgi": [4, 20], "regr_avgx": [4, 20], "regr_count": [4, 20], "regr_intercept": [4, 20], "regr_r2": [4, 20], "regr_slop": [4, 20], "regr_sxi": 4, "regr_sxx": [4, 20], "regr_syi": [4, 20], "regress": [4, 20], "regular": [4, 23], "rel": [4, 29], "relat": [5, 11, 25], "releas": [16, 29], "relev": 17, "reli": 17, "remain": 4, "remot": [7, 8], "remov": [1, 2, 4, 20], "renam": 2, "renamed_ag": 22, "repartit": [1, 2, 3, 5], "repartition_by_hash": 2, "repeat": [4, 22], "repeated_arrai": 22, "replac": 4, "repo": 17, "report": [2, 17], "repositori": [16, 31], "repres": [1, 2, 3, 4, 5, 9, 11, 12, 13, 19, 22, 27], "represent": [1, 2, 3, 4, 5, 9, 11], "request": [2, 17], "requested_schema": [1, 2], "requir": [2, 3, 14, 16, 23, 31], "reserv": [1, 5], "resolv": [17, 29], "resourc": 16, "respect": [2, 4, 20, 31], "respect_nul": [4, 20, 29], "result": [1, 2, 4, 5, 11, 12, 14, 18, 19, 20, 22, 25, 26, 27, 28, 29], "result_dict": 28, "retriev": [1, 3, 5, 25], "return": [0, 1, 2, 3, 5, 6, 7, 8, 9, 11, 13, 14, 22, 25, 27, 33], "return_typ": [5, 14], "reus": 16, "reusabl": 3, "revers": 4, "review": [16, 17], "rex": [3, 5], "rex_call_oper": [3, 5], "rex_call_operand": [3, 5], "rex_typ": [3, 5], "rextyp": [3, 5], "rfc3339": 4, "rh": [3, 5], "rhyhorn": 29, "right": [2, 4, 25], "right_on": [2, 25], "ritchi": 29, "robin": 2, "rock": 20, "roll": 29, "root": [4, 5, 11], "roption": 16, "round": [2, 4, 19], "rout": 16, "row": [1, 2, 3, 4, 5, 9, 14, 19, 20, 21, 22, 25, 27, 28, 29, 40], "row_numb": [4, 14, 29], "rpad": 4, "rresult": 16, "rstring": 16, "rtrim": 4, "rubi": 21, "run": [1, 2, 5, 9, 18, 28, 32], "runnabl": 17, "runtim": [1, 5, 14, 30], "runtimeconfig": 1, "runtimeenvbuild": [1, 5, 30], "rust": [4, 16, 18, 30, 31, 39], "rustc": 16, "rustflag": 17, "rustonomicon": 16, "rvec": 16, "s3": 31, "safe": 16, "safeti": 18, "same": [2, 4, 5, 14, 16, 19, 27], "sampl": [4, 21, 28], "saur": 23, "save": 14, "scalar": [3, 5, 14, 22, 24], "scalarsubqueri": 3, "scalarudf": [1, 5, 14], "scalarvalu": 14, "scalarvari": 3, "scan": [1, 5, 11], "schema": [0, 1, 2, 3, 5, 9, 11, 21], "schema_infer_max_record": [1, 5, 9], "schema_nam": [3, 5], "scheme": 2, "scienc": 23, "score": 4, "search": 4, "second": [4, 19, 20, 22], "second_arrai": 4, "secret_access_kei": 31, "section": [16, 19, 21, 24, 25, 29, 31], "see": [1, 2, 3, 4, 5, 12, 13, 14, 16, 17, 20, 22, 27, 29], "seen": [14, 20], "select": [1, 2, 3, 4, 5, 9, 14, 19, 22, 23, 24, 27, 28, 29, 33, 40], "select_column": 2, "self": [5, 12, 14, 27, 39], "semi": [2, 24], "sensit": 2, "separ": 4, "seper": 4, "sequenc": 2, "serd": 13, "seri": 22, "serial": [13, 34], "serialize_byt": 13, "serialize_to_plan": 13, "serv": 16, "session": [1, 5, 30, 32], "session_id": 1, "sessionconfig": [1, 5, 30], "sessioncontext": [1, 2, 4, 5, 6, 11, 13, 16, 18, 19, 20, 21, 22, 23, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 38, 39, 40], "sessioncontextintern": 1, "set": [0, 1, 3, 4, 5, 14, 16, 17, 19, 24, 27, 30], "sever": 26, "sha": 4, "sha224": 4, "sha256": 4, "sha384": 4, "sha512": 4, "sharabl": 16, "share": [16, 17, 19, 22, 33], "shift_offet": 4, "shift_offset": 4, "shot": 14, "should": [1, 3, 4, 5, 6, 9, 11, 13, 17, 20, 25, 27, 29], "show": [2, 16, 18, 19, 21, 22, 25, 27, 29, 31, 32, 39], "side": [4, 16], "sign": 4, "signific": 31, "significantli": 4, "signum": 4, "silver": 4, "similar": [4, 16, 19, 22, 29], "similarto": 3, "simpl": [4, 17, 26, 37, 38], "simplest": [14, 27], "simpli": [2, 5, 14, 16, 17], "simplifi": 29, "sin": 4, "sinc": [2, 20, 27, 31], "sine": 4, "singl": [1, 2, 3, 4, 5, 11, 14, 20, 22, 27, 29], "sinh": 4, "size": [1, 2, 4, 5, 22], "skip": [1, 2, 5, 9, 14], "skip_metadata": [1, 5, 9], "slice": 4, "slope": 4, "slow": 2, "slower": 2, "slowest": 27, "slowpok": 29, "small": 31, "smallest": [14, 20], "smooth_a": 27, "snappi": 2, "snorlax": 29, "so": [1, 2, 5, 16, 17, 26, 27, 29, 33, 39], "softwar": [5, 11, 16], "some": [4, 14, 16, 17, 20, 23, 29, 32, 39], "sometim": [1, 5, 16, 31], "soon": [4, 31], "sort": [1, 2, 3, 4, 5, 9, 20, 29], "sortexpr": [1, 2, 3, 4, 5], "sound": 16, "sourc": [1, 4, 5, 6, 7, 8, 9, 16, 17, 19, 32, 33, 39], "sp": [18, 31, 32], "space": 4, "sparingli": 27, "special": 14, "specif": [3, 5, 11, 21, 22, 29], "specifi": [1, 2, 3, 4, 5, 22, 25, 27, 29], "speed": [2, 18, 20, 29, 31, 32], "sphinx": 15, "spill": [1, 5], "spillabl": [1, 5], "split": [4, 27], "split_part": 4, "sql": [1, 5, 11, 13, 14, 18, 19, 22, 26, 28], "sql_with_opt": 1, "sqloption": [1, 5], "sqltabl": [6, 7, 8], "sqltype": [3, 5], "sqrt": 4, "squar": 4, "squi": 23, "squirtl": [18, 23, 29, 31, 32], "src": [3, 5, 17], "stabl": [14, 16, 27], "standard": [4, 16], "start": [3, 4, 5, 14, 22, 26, 29, 32], "start_ag": 22, "start_bound": [3, 5], "started_young": 22, "starts_with": 4, "state": [1, 5, 14, 19, 27], "state_typ": [5, 14], "statement": [1, 3, 4, 5, 19, 40], "static": [3, 5, 11, 13, 14], "statist": [2, 20, 21], "std": 21, "stddev": [4, 20], "stddev_pop": [4, 20], "stddev_samp": 4, "steel": 20, "step": [4, 16], "still": [27, 31], "stop": 4, "storag": 31, "store": [1, 3, 5, 10], "str": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 13, 14], "str_lit": 23, "straightforward": [34, 35], "stream": [1, 2, 5, 12, 16], "strftime": 4, "stride": 4, "string": [2, 3, 4, 5, 11, 14, 16, 17, 20, 21, 22, 24], "string1": 4, "string2": 4, "string_agg": [4, 20], "string_list": 4, "string_liter": [3, 5, 23], "string_view": [3, 5, 33], "strong": 18, "strpo": 4, "struct": [1, 3, 4, 5, 16, 24, 33], "structarrai": 33, "structur": [5, 11, 16], "style": [16, 22], "sub": [3, 5], "subfield": [3, 4, 5], "submit": 17, "submodul": 17, "subqueri": 3, "subqueryalia": 3, "subset": 26, "substr": 4, "substr_index": 4, "substrait": [5, 15], "subtract": [3, 5], "suffici": [1, 5], "suffix": 4, "suggest": 31, "sum": [4, 5, 14, 20, 27], "sum_bias_10": [5, 14], "summar": [2, 5, 14], "summari": [2, 20, 21], "support": [2, 3, 4, 5, 11, 13, 16, 25, 31], "supports_bounded_execut": [14, 27], "suppos": [4, 16, 20], "suppress_build_script_link_lin": 17, "sure": 17, "symbol": 2, "sync": 17, "synchon": 16, "syntax": 4, "system": [1, 5, 16, 17], "t": [4, 14, 26], "t1": 14, "tabl": [0, 1, 2, 5, 6, 7, 8, 9, 11, 16, 19, 21, 23, 25, 32, 33, 35, 36, 38], "table_exist": 1, "table_nam": [6, 7, 8], "table_partition_col": [1, 5, 9], "table_provid": 1, "tableprovid": [16, 39], "tableproviderexport": 1, "tablescan": 3, "tail": 2, "take": [2, 14, 16, 17, 20, 22, 27, 29], "tan": 4, "tangent": 4, "tanh": 4, "target": [1, 5], "target_partit": [1, 5], "task": [23, 33], "technic": 18, "tempor": 24, "temporari": [1, 5], "term": 29, "terminologi": 16, "test": [4, 17], "text": [1, 4], "textual": 23, "th": 4, "than": [2, 3, 4, 5, 20], "thei": [6, 14, 16, 22, 27], "them": [4, 16, 17, 19, 21], "then_expr": 3, "therefor": 2, "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 27, 28, 29, 31, 32, 33, 39], "third": 19, "thoroughli": 16, "those": [2, 3, 5, 18, 20, 27, 31], "though": 27, "thread": 18, "three": [27, 29, 31], "through": [16, 18, 24, 31, 32], "thu": 14, "thusli": 16, "ticket": 17, "tie": 4, "tight": 16, "tile": 4, "time": [4, 14, 16, 17, 20, 22, 23, 27, 33], "time64": 4, "timestamp": [4, 23], "tip_amount": [19, 26], "tip_perc": 19, "tips_plus_tol": 26, "tlc": 26, "tmp": [1, 5], "to_arrow_t": 2, "to_hex": 4, "to_panda": [2, 21, 23, 40], "to_polar": 2, "to_proto": [5, 11], "to_pyarrow": [5, 12], "to_pyarrow_dataset": 31, "to_pydict": [2, 28], "to_pylist": 2, "to_str": 39, "to_substrait_plan": 13, "to_timestamp": [4, 23], "to_timestamp_micro": 4, "to_timestamp_milli": 4, "to_timestamp_nano": 4, "to_timestamp_second": 4, "to_unixtim": 4, "to_val": 4, "to_vari": [3, 5, 11], "togeth": [2, 4, 20], "tolls_amount": 26, "toml": 17, "top": 21, "topic": 31, "total": [2, 4, 18, 19, 22, 23, 31, 32], "total_amount": 19, "total_as_float": 23, "total_as_int": 23, "toward": 4, "tracker": 4, "tradit": 17, "trait": [14, 16], "transact": [1, 5], "transfer": 16, "transform": [2, 5, 11, 19], "translat": [4, 16], "treat": [3, 29], "treatment": [3, 5], "tree": [5, 11, 22], "trigger": 2, "trim": 4, "trip": [26, 31], "trip_dist": [19, 26], "trivial": [2, 17], "tru": 2, "true": [1, 2, 3, 4, 5, 6, 7, 8, 9, 14, 17, 20, 22, 23, 26, 27, 29, 30], "trunc": 4, "truncat": [4, 20, 23, 26, 29], "try": [1, 5, 9, 16], "trycast": 3, "tupl": [1, 2, 4, 5, 9, 14], "turn": [2, 3, 5, 16], "tutori": 32, "two": [2, 3, 4, 5, 11, 16, 20, 22, 25, 27, 29, 30], "type": [1, 2, 3, 4, 5, 9, 14, 16, 17, 18, 20, 22, 23, 26, 27, 29, 31, 32], "typic": [0, 3, 5, 12, 14, 19], "typing_extens": [5, 12], "u": [16, 20, 22, 31], "udaf": [1, 5, 14, 18, 27], "udaf1": [5, 14], "udaf2": [5, 14], "udaf3": [5, 14], "udf": [1, 5, 15, 18, 27], "udf4": [5, 14], "udwf": [1, 5, 14], "udwf1": [5, 14], "udwf2": [5, 14], "udwf3": [5, 14], "ultim": 17, "unari": [5, 11], "unbound": [1, 3, 5, 14, 29], "uncompress": 2, "undefin": 17, "under": [1, 16], "underli": [3, 5, 16], "unfortun": 16, "unicod": 4, "union": [2, 3, 4], "union_distinct": 2, "uniqu": [1, 4, 14, 20], "unit": [3, 5, 29], "unixtim": 4, "unknown": 3, "unlik": [3, 5, 29], "unmatch": 25, "unnest": [2, 3], "unnest_column": 2, "unnestexpr": 3, "unoptim": 2, "unsaf": 16, "unspil": [1, 5], "until": 19, "unwrap": 39, "up": [5, 11, 14, 19, 22, 29], "updat": [1, 2, 5, 14, 27], "upon": [4, 16, 27], "upper": 4, "uppercas": 4, "upstream": 16, "urbango": 25, "url": 1, "us": [1, 2, 3, 4, 5, 6, 7, 9, 11, 13, 14, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 35, 37, 38, 39], "usag": [1, 2, 3, 4, 5, 14, 20, 29], "user": [0, 1, 2, 3, 4, 5, 6, 11, 12, 13, 14, 16, 17, 19, 22, 23, 24, 31, 32], "uses_window_fram": [14, 27], "utc": 4, "utf8": [3, 4, 5], "utf8view": [3, 5], "util": [16, 29], "uuid": 4, "uv": 17, "v": 17, "v4": 4, "valid": [1, 3, 5, 6, 7, 8, 14], "valu": [1, 2, 3, 4, 5, 11, 14, 20, 22, 23, 25, 26, 27, 29], "value1": 4, "value2": 4, "value_i": 4, "value_x": 4, "valueerror": 2, "values_a": 27, "values_b": 27, "var": 4, "var_pop": [4, 20], "var_samp": [4, 20], "var_sampl": 4, "variabl": [1, 4, 5, 17, 22], "varianc": 4, "variant": [3, 5, 11, 25], "variant_nam": [3, 5], "varieti": [22, 27, 31], "variou": 32, "vastli": 17, "vec": 16, "vendorid": 26, "venomoth": 29, "venonat": 29, "venu": 23, "venufleur": 23, "venufleurmega": 23, "venusaur": [18, 23, 29, 31, 32], "venusaurmega": [18, 23, 29, 31, 32], "venv": 17, "verbos": 2, "veri": [34, 35], "verifi": 32, "verion": 31, "version": [16, 17, 31], "via": [1, 13, 16, 17, 18, 22, 25, 31, 32, 39, 40], "view": [1, 21, 23, 24, 32], "view1": 28, "viewtabl": 2, "vink": 29, "virtual": [1, 5, 17], "visual": [5, 11], "volatil": [5, 14, 27], "voltorb": [20, 29], "vulpix": 20, "wa": [1, 5], "wai": [16, 17, 20, 31, 32], "wait": 16, "want": [16, 17, 20, 23, 27, 29, 39], "wartortl": [18, 31, 32], "water": [18, 20, 23, 31, 32], "we": [2, 16, 17, 19, 20, 22, 23, 25, 26, 27, 29, 30, 32, 33], "weedl": [18, 29, 31, 32], "weight": [4, 22], "welcom": [17, 32], "well": [1, 5, 16, 17], "were": [16, 22], "what": [16, 19], "whatev": 14, "when": [1, 3, 4, 5, 9, 14, 16, 17, 18, 20, 22, 25, 27, 29, 30, 37], "when_expr": 3, "whenev": 17, "where": [3, 4, 5, 11, 20, 22, 27, 28, 29], "wherea": 22, "wherev": 16, "whether": [1, 3, 4, 5, 9, 14, 22], "which": [1, 2, 3, 4, 5, 14, 16, 17, 18, 20, 22, 26, 27, 29, 31, 33], "while": [14, 25], "who": 16, "whole": 20, "wide": [22, 30, 31], "window": [1, 3, 4, 5, 14, 20, 24], "window_fram": [3, 4, 5, 29], "windowevalu": [5, 14, 27], "windowexpr": 3, "windowfram": [3, 4, 5, 29], "windowframebound": [3, 5], "windowudf": [1, 5, 14], "wish": 16, "with_allow_ddl": [1, 5], "with_allow_dml": [1, 5], "with_allow_stat": [1, 5], "with_batch_s": [1, 5], "with_column": 2, "with_column_renam": 2, "with_create_default_catalog_and_schema": [1, 5, 30], "with_default_catalog_and_schema": [1, 5, 30], "with_disk_manager_dis": [1, 5], "with_disk_manager_o": [1, 5, 30], "with_disk_manager_specifi": [1, 5], "with_fair_spill_pool": [1, 5, 30], "with_greedy_memory_pool": [1, 5], "with_head": 2, "with_information_schema": [1, 5, 30], "with_parquet_prun": [1, 5, 30], "with_repartition_aggreg": [1, 5, 30], "with_repartition_file_min_s": [1, 5], "with_repartition_file_scan": [1, 5], "with_repartition_join": [1, 5, 30], "with_repartition_sort": [1, 5], "with_repartition_window": [1, 5, 30], "with_target_partit": [1, 5, 30], "with_temp_file_path": [1, 5], "with_unbounded_memory_pool": [1, 5], "within": [4, 7, 14, 20, 22], "within_limit": 2, "without": [4, 16, 17, 20, 23, 25, 26, 27], "won": 26, "word": 4, "work": [1, 4, 5, 23, 26, 32], "workflow": 17, "would": [3, 4, 6, 14, 16], "wrap": [1, 2, 16], "wrapper": [1, 5, 12, 17], "write": [2, 6, 13, 16, 27], "write_csv": 2, "write_json": 2, "write_parquet": 2, "written": [16, 18], "x": [4, 5, 14, 18, 23, 29, 31, 32, 40], "xor": 4, "y": [4, 14, 18, 23, 29, 31, 32], "year": 4, "years_in_posit": 22, "yellow": 31, "yellow_tripdata_2021": [19, 26], "yet": 2, "yield": 4, "you": [1, 4, 5, 14, 16, 17, 18, 19, 20, 21, 22, 23, 26, 27, 28, 29, 30, 31, 32, 33, 39], "your": [5, 14, 16, 17, 20, 21, 26, 27, 39], "yourself": 16, "z": [1, 5, 14], "zero": [2, 4, 18, 33], "zstandard": 2, "zstd": 2, "zubat": 20, "\u03c0": 4}, "titles": ["datafusion.catalog", "datafusion.context", "datafusion.dataframe", "datafusion.expr", "datafusion.functions", "datafusion", "datafusion.input.base", "datafusion.input", "datafusion.input.location", "datafusion.io", "datafusion.object_store", "datafusion.plan", "datafusion.record_batch", "datafusion.substrait", "datafusion.udf", "API Reference", "Python Extensions", "Introduction", "DataFusion in Python", "Concepts", "Aggregation", "Basic Operations", "Expressions", "Functions", "Common Operations", "Joins", "Column Selections", "User-Defined Functions", "Registering Views", "Window Functions", "Configuration", "Data Sources", "Introduction", "Arrow", "Avro", "CSV", "IO", "JSON", "Parquet", "Custom Table Provider", "SQL"], "titleterms": {"The": 16, "aggreg": [20, 27, 29], "altern": 16, "anti": 25, "api": 15, "approach": 16, "arrai": 22, "arrow": [16, 33], "attribut": [3, 5, 10, 14], "avail": 29, "avro": 34, "base": 6, "basic": 21, "boolean": 22, "build": 17, "cast": 23, "catalog": 0, "class": [0, 1, 2, 3, 5, 6, 7, 8, 11, 12, 13, 14], "code": 17, "column": [22, 26], "commit": 17, "common": 24, "concept": 19, "condit": 23, "configur": 30, "content": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14], "context": [1, 19], "creat": 31, "csv": 35, "custom": [31, 39], "data": 31, "datafram": [2, 19, 31], "datafus": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 18, 33], "defin": 27, "delta": 31, "depend": 17, "detail": 16, "develop": 17, "distinct": 20, "exampl": 18, "export": 33, "expr": 3, "express": [19, 22], "extens": 16, "ffi": 16, "file": 31, "filter": 20, "frame": 29, "from": [16, 33], "full": 25, "function": [4, 5, 9, 20, 22, 23, 27, 29], "guidelin": 17, "hook": 17, "how": 17, "iceberg": 31, "implement": 16, "import": 33, "improv": 17, "inner": 25, "input": [6, 7, 8], "inspir": 16, "instal": [17, 18, 32], "introduct": [17, 32], "io": [9, 36], "issu": 16, "join": 25, "json": 37, "lake": 31, "left": 25, "librari": 31, "liter": 22, "local": 31, "locat": 8, "mathemat": 23, "memori": 31, "modul": [0, 1, 2, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14], "null": [20, 29], "object": 31, "object_stor": 10, "oper": [21, 24], "option": 27, "order": [20, 29], "other": [23, 31], "packag": [5, 7], "paramet": [20, 29], "parquet": 38, "partit": 29, "plan": 11, "pre": 17, "primari": 16, "provid": [31, 39], "python": [16, 17, 18], "record_batch": 12, "refer": 15, "regist": 28, "return": 4, "run": 17, "rust": 17, "scalar": 27, "select": 26, "semi": 25, "separ": 17, "session": 19, "set": [20, 29], "sourc": 31, "speed": 17, "sql": 40, "statu": 16, "store": 31, "string": 23, "struct": 22, "submodul": [5, 7], "substrait": 13, "tabl": [31, 39], "tempor": 23, "treatment": [20, 29], "udf": 14, "udwf": 27, "updat": 17, "user": 27, "view": 28, "window": [27, 29], "work": 16}}) \ No newline at end of file +Search.setIndex({"alltitles": {"API Reference": [[19, null]], "Aggregate Functions": [[24, "aggregate-functions"], [31, "aggregate-functions"], [33, "aggregate-functions"]], "Aggregation": [[24, null]], "Alternative Approach": [[20, "alternative-approach"]], "Arrays": [[26, "arrays"]], "Arrow": [[38, null]], "Attributes": [[1, "attributes"], [4, "attributes"], [7, "attributes"], [12, "attributes"], [18, "attributes"]], "Available Functions": [[33, "available-functions"]], "Avro": [[39, null]], "Basic Operations": [[25, null]], "Basic Usage": [[36, "basic-usage"]], "Boolean": [[26, "boolean"]], "CSV": [[40, null]], "Casting": [[27, "casting"]], "Classes": [[0, "classes"], [2, "classes"], [3, "classes"], [4, "classes"], [6, "classes"], [7, "classes"], [8, "classes"], [9, "classes"], [10, "classes"], [13, "classes"], [14, "classes"], [15, "classes"], [17, "classes"], [18, "classes"]], "Column": [[26, "column"]], "Column Selections": [[30, null]], "Common Operations": [[28, null]], "Concepts": [[23, null]], "Conditional": [[27, "conditional"]], "Configuration": [[34, null]], "Contextual Formatting": [[36, "contextual-formatting"]], "Create in-memory": [[35, "create-in-memory"]], "Creating a Custom Formatter": [[36, "creating-a-custom-formatter"]], "Custom Style Providers": [[36, "custom-style-providers"]], "Custom Table Provider": [[35, "custom-table-provider"], [44, null]], "Customizing HTML Rendering": [[36, "customizing-html-rendering"]], "Data Sources": [[35, null]], "DataFrame": [[23, "dataframe"]], "DataFrames": [[36, null]], "DataFusion in Python": [[22, null]], "Delta Lake": [[35, "delta-lake"]], "Distinct": [[24, "distinct"]], "Example": [[22, "example"]], "Exporting from DataFusion": [[38, "exporting-from-datafusion"]], "Expressions": [[23, "expressions"], [26, null]], "Filter": [[24, "filter"]], "Full Join": [[29, "full-join"]], "Functions": [[5, "functions"], [6, "functions"], [7, "functions"], [11, "functions"], [26, "functions"], [27, null]], "Guidelines for Separating Python and Rust Code": [[21, "guidelines-for-separating-python-and-rust-code"]], "HTML Rendering": [[36, "html-rendering"]], "Handling Missing Values": [[27, "handling-missing-values"]], "How to develop": [[21, "how-to-develop"]], "IO": [[41, null]], "Iceberg": [[35, "iceberg"]], "Implementation Details": [[20, "implementation-details"]], "Importing to DataFusion": [[38, "importing-to-datafusion"]], "Improving Build Speed": [[21, "improving-build-speed"]], "Inner Join": [[29, "inner-join"]], "Inspiration from Arrow": [[20, "inspiration-from-arrow"]], "Install": [[22, "install"]], "Installation": [[37, "installation"]], "Introduction": [[21, null], [37, null]], "JSON": [[42, null]], "Joins": [[29, null]], "Left Anti Join": [[29, "left-anti-join"]], "Left Join": [[29, "left-join"]], "Left Semi Join": [[29, "left-semi-join"]], "Literal": [[26, "literal"]], "Local file": [[35, "local-file"]], "Managing Formatters": [[36, "managing-formatters"]], "Mathematical": [[27, "mathematical"]], "Memory and Display Controls": [[36, "memory-and-display-controls"]], "Module Contents": [[0, "module-contents"], [1, "module-contents"], [2, "module-contents"], [3, "module-contents"], [4, "module-contents"], [5, "module-contents"], [6, "module-contents"], [8, "module-contents"], [10, "module-contents"], [11, "module-contents"], [12, "module-contents"], [13, "module-contents"], [14, "module-contents"], [15, "module-contents"], [17, "module-contents"], [18, "module-contents"]], "Null Treatment": [[24, "null-treatment"], [33, "null-treatment"]], "Object Store": [[35, "object-store"]], "Ordering": [[24, "ordering"], [33, "ordering"]], "Other": [[27, "other"]], "Other DataFrame Libraries": [[35, "other-dataframe-libraries"]], "Overview": [[36, "overview"]], "Package Contents": [[7, "package-contents"], [9, "package-contents"]], "Parquet": [[43, null]], "Partitions": [[33, "partitions"]], "Performance Optimization with Shared Styles": [[36, "performance-optimization-with-shared-styles"]], "Python Extensions": [[20, null]], "Registering Views": [[32, null]], "Returns:": [[4, "returns"], [4, "id1"], [5, "returns"], [5, "id1"], [7, "returns"], [7, "id1"]], "Running & Installing pre-commit hooks": [[21, "running-installing-pre-commit-hooks"]], "SQL": [[45, null]], "Scalar Functions": [[31, "scalar-functions"]], "Session Context": [[23, "session-context"]], "Setting Parameters": [[24, "setting-parameters"], [33, "setting-parameters"]], "Status of Work": [[20, "status-of-work"]], "String": [[27, "string"]], "Structs": [[26, "structs"]], "Submodules": [[7, "submodules"], [9, "submodules"]], "Table Functions": [[31, "table-functions"]], "Temporal": [[27, "temporal"]], "The FFI Approach": [[20, "the-ffi-approach"]], "The Primary Issue": [[20, "the-primary-issue"]], "UDWF options": [[31, "udwf-options"]], "Update Dependencies": [[21, "update-dependencies"]], "User-Defined Functions": [[31, null]], "Window Frame": [[33, "window-frame"]], "Window Functions": [[31, "window-functions"], [33, null]], "datafusion": [[7, null]], "datafusion.catalog": [[0, null]], "datafusion.col": [[1, null]], "datafusion.context": [[2, null]], "datafusion.dataframe": [[3, null]], "datafusion.expr": [[4, null]], "datafusion.functions": [[5, null]], "datafusion.html_formatter": [[6, null]], "datafusion.input": [[9, null]], "datafusion.input.base": [[8, null]], "datafusion.input.location": [[10, null]], "datafusion.io": [[11, null]], "datafusion.object_store": [[12, null]], "datafusion.plan": [[13, null]], "datafusion.record_batch": [[14, null]], "datafusion.substrait": [[15, null]], "datafusion.udf": [[16, null]], "datafusion.unparser": [[17, null]], "datafusion.user_defined": [[18, null]], "fill_null": [[27, "fill-null"]]}, "docnames": ["autoapi/datafusion/catalog/index", "autoapi/datafusion/col/index", "autoapi/datafusion/context/index", "autoapi/datafusion/dataframe/index", "autoapi/datafusion/expr/index", "autoapi/datafusion/functions/index", "autoapi/datafusion/html_formatter/index", "autoapi/datafusion/index", "autoapi/datafusion/input/base/index", "autoapi/datafusion/input/index", "autoapi/datafusion/input/location/index", "autoapi/datafusion/io/index", "autoapi/datafusion/object_store/index", "autoapi/datafusion/plan/index", "autoapi/datafusion/record_batch/index", "autoapi/datafusion/substrait/index", "autoapi/datafusion/udf/index", "autoapi/datafusion/unparser/index", "autoapi/datafusion/user_defined/index", "autoapi/index", "contributor-guide/ffi", "contributor-guide/introduction", "index", "user-guide/basics", "user-guide/common-operations/aggregations", "user-guide/common-operations/basic-info", "user-guide/common-operations/expressions", "user-guide/common-operations/functions", "user-guide/common-operations/index", "user-guide/common-operations/joins", "user-guide/common-operations/select-and-filter", "user-guide/common-operations/udf-and-udfa", "user-guide/common-operations/views", "user-guide/common-operations/windows", "user-guide/configuration", "user-guide/data-sources", "user-guide/dataframe", "user-guide/introduction", "user-guide/io/arrow", "user-guide/io/avro", "user-guide/io/csv", "user-guide/io/index", "user-guide/io/json", "user-guide/io/parquet", "user-guide/io/table_provider", "user-guide/sql"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["autoapi/datafusion/catalog/index.rst", "autoapi/datafusion/col/index.rst", "autoapi/datafusion/context/index.rst", "autoapi/datafusion/dataframe/index.rst", "autoapi/datafusion/expr/index.rst", "autoapi/datafusion/functions/index.rst", "autoapi/datafusion/html_formatter/index.rst", "autoapi/datafusion/index.rst", "autoapi/datafusion/input/base/index.rst", "autoapi/datafusion/input/index.rst", "autoapi/datafusion/input/location/index.rst", "autoapi/datafusion/io/index.rst", "autoapi/datafusion/object_store/index.rst", "autoapi/datafusion/plan/index.rst", "autoapi/datafusion/record_batch/index.rst", "autoapi/datafusion/substrait/index.rst", "autoapi/datafusion/udf/index.rst", "autoapi/datafusion/unparser/index.rst", "autoapi/datafusion/user_defined/index.rst", "autoapi/index.rst", "contributor-guide/ffi.rst", "contributor-guide/introduction.rst", "index.rst", "user-guide/basics.rst", "user-guide/common-operations/aggregations.rst", "user-guide/common-operations/basic-info.rst", "user-guide/common-operations/expressions.rst", "user-guide/common-operations/functions.rst", "user-guide/common-operations/index.rst", "user-guide/common-operations/joins.rst", "user-guide/common-operations/select-and-filter.rst", "user-guide/common-operations/udf-and-udfa.rst", "user-guide/common-operations/views.rst", "user-guide/common-operations/windows.rst", "user-guide/configuration.rst", "user-guide/data-sources.rst", "user-guide/dataframe.rst", "user-guide/introduction.rst", "user-guide/io/arrow.rst", "user-guide/io/avro.rst", "user-guide/io/csv.rst", "user-guide/io/index.rst", "user-guide/io/json.rst", "user-guide/io/parquet.rst", "user-guide/io/table_provider.rst", "user-guide/sql.rst"], "indexentries": {"__add__() (datafusion.expr method)": [[7, "datafusion.Expr.__add__", false]], "__add__() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.__add__", false]], "__aiter__() (datafusion.record_batch.recordbatchstream method)": [[14, "datafusion.record_batch.RecordBatchStream.__aiter__", false]], "__aiter__() (datafusion.recordbatchstream method)": [[7, "datafusion.RecordBatchStream.__aiter__", false]], "__and__() (datafusion.expr method)": [[7, "datafusion.Expr.__and__", false]], "__and__() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.__and__", false]], "__anext__() (datafusion.record_batch.recordbatchstream method)": [[14, "datafusion.record_batch.RecordBatchStream.__anext__", false]], "__anext__() (datafusion.recordbatchstream method)": [[7, "datafusion.RecordBatchStream.__anext__", false]], "__arrow_c_array__() (datafusion.context.arrowarrayexportable method)": [[2, "datafusion.context.ArrowArrayExportable.__arrow_c_array__", false]], "__arrow_c_stream__() (datafusion.context.arrowstreamexportable method)": [[2, "datafusion.context.ArrowStreamExportable.__arrow_c_stream__", false]], "__arrow_c_stream__() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.__arrow_c_stream__", false]], "__call__() (datafusion.aggregateudf method)": [[7, "datafusion.AggregateUDF.__call__", false]], "__call__() (datafusion.html_formatter.cellformatter method)": [[6, "datafusion.html_formatter.CellFormatter.__call__", false]], "__call__() (datafusion.scalarudf method)": [[7, "datafusion.ScalarUDF.__call__", false]], "__call__() (datafusion.tablefunction method)": [[7, "datafusion.TableFunction.__call__", false]], "__call__() (datafusion.user_defined.aggregateudf method)": [[18, "datafusion.user_defined.AggregateUDF.__call__", false]], "__call__() (datafusion.user_defined.scalarudf method)": [[18, "datafusion.user_defined.ScalarUDF.__call__", false]], "__call__() (datafusion.user_defined.tablefunction method)": [[18, "datafusion.user_defined.TableFunction.__call__", false]], "__call__() (datafusion.user_defined.windowudf method)": [[18, "datafusion.user_defined.WindowUDF.__call__", false]], "__call__() (datafusion.windowudf method)": [[7, "datafusion.WindowUDF.__call__", false]], "__datafusion_table_provider__() (datafusion.context.tableproviderexportable method)": [[2, "datafusion.context.TableProviderExportable.__datafusion_table_provider__", false]], "__eq__() (datafusion.expr method)": [[7, "datafusion.Expr.__eq__", false]], "__eq__() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.__eq__", false]], "__ge__() (datafusion.expr method)": [[7, "datafusion.Expr.__ge__", false]], "__ge__() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.__ge__", false]], "__getitem__() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.__getitem__", false]], "__getitem__() (datafusion.expr method)": [[7, "datafusion.Expr.__getitem__", false]], "__getitem__() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.__getitem__", false]], "__gt__() (datafusion.expr method)": [[7, "datafusion.Expr.__gt__", false]], "__gt__() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.__gt__", false]], "__invert__() (datafusion.expr method)": [[7, "datafusion.Expr.__invert__", false]], "__invert__() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.__invert__", false]], "__iter__() (datafusion.record_batch.recordbatchstream method)": [[14, "datafusion.record_batch.RecordBatchStream.__iter__", false]], "__iter__() (datafusion.recordbatchstream method)": [[7, "datafusion.RecordBatchStream.__iter__", false]], "__le__() (datafusion.expr method)": [[7, "datafusion.Expr.__le__", false]], "__le__() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.__le__", false]], "__lt__() (datafusion.expr method)": [[7, "datafusion.Expr.__lt__", false]], "__lt__() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.__lt__", false]], "__mod__() (datafusion.expr method)": [[7, "datafusion.Expr.__mod__", false]], "__mod__() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.__mod__", false]], "__mul__() (datafusion.expr method)": [[7, "datafusion.Expr.__mul__", false]], "__mul__() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.__mul__", false]], "__ne__() (datafusion.expr method)": [[7, "datafusion.Expr.__ne__", false]], "__ne__() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.__ne__", false]], "__next__() (datafusion.record_batch.recordbatchstream method)": [[14, "datafusion.record_batch.RecordBatchStream.__next__", false]], "__next__() (datafusion.recordbatchstream method)": [[7, "datafusion.RecordBatchStream.__next__", false]], "__or__() (datafusion.expr method)": [[7, "datafusion.Expr.__or__", false]], "__or__() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.__or__", false]], "__radd__ (datafusion.expr attribute)": [[7, "datafusion.Expr.__radd__", false]], "__radd__ (datafusion.expr.expr attribute)": [[4, "datafusion.expr.Expr.__radd__", false]], "__rand__ (datafusion.expr attribute)": [[7, "datafusion.Expr.__rand__", false]], "__rand__ (datafusion.expr.expr attribute)": [[4, "datafusion.expr.Expr.__rand__", false]], "__repr__() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.__repr__", false]], "__repr__() (datafusion.executionplan method)": [[7, "datafusion.ExecutionPlan.__repr__", false]], "__repr__() (datafusion.expr method)": [[7, "datafusion.Expr.__repr__", false]], "__repr__() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.__repr__", false]], "__repr__() (datafusion.expr.sortexpr method)": [[4, "datafusion.expr.SortExpr.__repr__", false]], "__repr__() (datafusion.logicalplan method)": [[7, "datafusion.LogicalPlan.__repr__", false]], "__repr__() (datafusion.plan.executionplan method)": [[13, "datafusion.plan.ExecutionPlan.__repr__", false]], "__repr__() (datafusion.plan.logicalplan method)": [[13, "datafusion.plan.LogicalPlan.__repr__", false]], "__repr__() (datafusion.tablefunction method)": [[7, "datafusion.TableFunction.__repr__", false]], "__repr__() (datafusion.user_defined.tablefunction method)": [[18, "datafusion.user_defined.TableFunction.__repr__", false]], "__richcmp__() (datafusion.expr method)": [[7, "datafusion.Expr.__richcmp__", false]], "__richcmp__() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.__richcmp__", false]], "__rmod__ (datafusion.expr attribute)": [[7, "datafusion.Expr.__rmod__", false]], "__rmod__ (datafusion.expr.expr attribute)": [[4, "datafusion.expr.Expr.__rmod__", false]], "__rmul__ (datafusion.expr attribute)": [[7, "datafusion.Expr.__rmul__", false]], "__rmul__ (datafusion.expr.expr attribute)": [[4, "datafusion.expr.Expr.__rmul__", false]], "__ror__ (datafusion.expr attribute)": [[7, "datafusion.Expr.__ror__", false]], "__ror__ (datafusion.expr.expr attribute)": [[4, "datafusion.expr.Expr.__ror__", false]], "__rsub__ (datafusion.expr attribute)": [[7, "datafusion.Expr.__rsub__", false]], "__rsub__ (datafusion.expr.expr attribute)": [[4, "datafusion.expr.Expr.__rsub__", false]], "__rtruediv__ (datafusion.expr attribute)": [[7, "datafusion.Expr.__rtruediv__", false]], "__rtruediv__ (datafusion.expr.expr attribute)": [[4, "datafusion.expr.Expr.__rtruediv__", false]], "__str__() (datafusion.user_defined.volatility method)": [[18, "datafusion.user_defined.Volatility.__str__", false]], "__sub__() (datafusion.expr method)": [[7, "datafusion.Expr.__sub__", false]], "__sub__() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.__sub__", false]], "__truediv__() (datafusion.expr method)": [[7, "datafusion.Expr.__truediv__", false]], "__truediv__() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.__truediv__", false]], "_build_expandable_cell() (datafusion.html_formatter.dataframehtmlformatter method)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter._build_expandable_cell", false]], "_build_html_footer() (datafusion.html_formatter.dataframehtmlformatter method)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter._build_html_footer", false]], "_build_html_header() (datafusion.html_formatter.dataframehtmlformatter method)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter._build_html_header", false]], "_build_regular_cell() (datafusion.html_formatter.dataframehtmlformatter method)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter._build_regular_cell", false]], "_build_table_body() (datafusion.html_formatter.dataframehtmlformatter method)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter._build_table_body", false]], "_build_table_container_start() (datafusion.html_formatter.dataframehtmlformatter method)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter._build_table_container_start", false]], "_build_table_header() (datafusion.html_formatter.dataframehtmlformatter method)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter._build_table_header", false]], "_create_table_udf() (datafusion.tablefunction static method)": [[7, "datafusion.TableFunction._create_table_udf", false]], "_create_table_udf() (datafusion.user_defined.tablefunction static method)": [[18, "datafusion.user_defined.TableFunction._create_table_udf", false]], "_create_table_udf_decorator() (datafusion.tablefunction static method)": [[7, "datafusion.TableFunction._create_table_udf_decorator", false]], "_create_table_udf_decorator() (datafusion.user_defined.tablefunction static method)": [[18, "datafusion.user_defined.TableFunction._create_table_udf_decorator", false]], "_create_window_udf() (datafusion.user_defined.windowudf static method)": [[18, "datafusion.user_defined.WindowUDF._create_window_udf", false]], "_create_window_udf() (datafusion.windowudf static method)": [[7, "datafusion.WindowUDF._create_window_udf", false]], "_create_window_udf_decorator() (datafusion.user_defined.windowudf static method)": [[18, "datafusion.user_defined.WindowUDF._create_window_udf_decorator", false]], "_create_window_udf_decorator() (datafusion.windowudf static method)": [[7, "datafusion.WindowUDF._create_window_udf_decorator", false]], "_custom_cell_builder (datafusion.html_formatter.dataframehtmlformatter attribute)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter._custom_cell_builder", false]], "_custom_header_builder (datafusion.html_formatter.dataframehtmlformatter attribute)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter._custom_header_builder", false]], "_default_formatter (datafusion.html_formatter.formattermanager attribute)": [[6, "datafusion.html_formatter.FormatterManager._default_formatter", false]], "_format_cell_value() (datafusion.html_formatter.dataframehtmlformatter method)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter._format_cell_value", false]], "_get_cell_value() (datafusion.html_formatter.dataframehtmlformatter method)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter._get_cell_value", false]], "_get_default_css() (datafusion.html_formatter.dataframehtmlformatter method)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter._get_default_css", false]], "_get_default_name() (datafusion.user_defined.windowudf static method)": [[18, "datafusion.user_defined.WindowUDF._get_default_name", false]], "_get_default_name() (datafusion.windowudf static method)": [[7, "datafusion.WindowUDF._get_default_name", false]], "_get_javascript() (datafusion.html_formatter.dataframehtmlformatter method)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter._get_javascript", false]], "_normalize_input_types() (datafusion.user_defined.windowudf static method)": [[18, "datafusion.user_defined.WindowUDF._normalize_input_types", false]], "_normalize_input_types() (datafusion.windowudf static method)": [[7, "datafusion.WindowUDF._normalize_input_types", false]], "_null_treatment (datafusion.expr.window attribute)": [[4, "datafusion.expr.Window._null_treatment", false]], "_order_by (datafusion.expr.window attribute)": [[4, "datafusion.expr.Window._order_by", false]], "_partition_by (datafusion.expr.window attribute)": [[4, "datafusion.expr.Window._partition_by", false]], "_r (in module datafusion.user_defined)": [[18, "datafusion.user_defined._R", false]], "_raw_plan (datafusion.executionplan attribute)": [[7, "datafusion.ExecutionPlan._raw_plan", false]], "_raw_plan (datafusion.logicalplan attribute)": [[7, "datafusion.LogicalPlan._raw_plan", false]], "_raw_plan (datafusion.plan.executionplan attribute)": [[13, "datafusion.plan.ExecutionPlan._raw_plan", false]], "_raw_plan (datafusion.plan.logicalplan attribute)": [[13, "datafusion.plan.LogicalPlan._raw_plan", false]], "_refresh_formatter_reference() (in module datafusion.html_formatter)": [[6, "datafusion.html_formatter._refresh_formatter_reference", false]], "_repr_html_() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame._repr_html_", false]], "_styles_loaded (datafusion.html_formatter.dataframehtmlformatter attribute)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter._styles_loaded", false]], "_to_pyarrow_types (datafusion.expr attribute)": [[7, "datafusion.Expr._to_pyarrow_types", false]], "_to_pyarrow_types (datafusion.expr.expr attribute)": [[4, "datafusion.expr.Expr._to_pyarrow_types", false]], "_type_formatters (datafusion.html_formatter.dataframehtmlformatter attribute)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter._type_formatters", false]], "_udaf (datafusion.aggregateudf attribute)": [[7, "datafusion.AggregateUDF._udaf", false]], "_udaf (datafusion.user_defined.aggregateudf attribute)": [[18, "datafusion.user_defined.AggregateUDF._udaf", false]], "_udf (datafusion.scalarudf attribute)": [[7, "datafusion.ScalarUDF._udf", false]], "_udf (datafusion.user_defined.scalarudf attribute)": [[18, "datafusion.user_defined.ScalarUDF._udf", false]], "_udtf (datafusion.tablefunction attribute)": [[7, "datafusion.TableFunction._udtf", false]], "_udtf (datafusion.user_defined.tablefunction attribute)": [[18, "datafusion.user_defined.TableFunction._udtf", false]], "_udwf (datafusion.user_defined.windowudf attribute)": [[18, "datafusion.user_defined.WindowUDF._udwf", false]], "_udwf (datafusion.windowudf attribute)": [[7, "datafusion.WindowUDF._udwf", false]], "_validate_bool() (in module datafusion.html_formatter)": [[6, "datafusion.html_formatter._validate_bool", false]], "_validate_positive_int() (in module datafusion.html_formatter)": [[6, "datafusion.html_formatter._validate_positive_int", false]], "_window_frame (datafusion.expr.window attribute)": [[4, "datafusion.expr.Window._window_frame", false]], "abs() (datafusion.expr method)": [[7, "datafusion.Expr.abs", false]], "abs() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.abs", false]], "abs() (in module datafusion.functions)": [[5, "datafusion.functions.abs", false]], "accumulator (class in datafusion)": [[7, "datafusion.Accumulator", false]], "accumulator (class in datafusion.user_defined)": [[18, "datafusion.user_defined.Accumulator", false]], "acos() (datafusion.expr method)": [[7, "datafusion.Expr.acos", false]], "acos() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.acos", false]], "acos() (in module datafusion.functions)": [[5, "datafusion.functions.acos", false]], "acosh() (datafusion.expr method)": [[7, "datafusion.Expr.acosh", false]], "acosh() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.acosh", false]], "acosh() (in module datafusion.functions)": [[5, "datafusion.functions.acosh", false]], "aggregate (in module datafusion.expr)": [[4, "datafusion.expr.Aggregate", false]], "aggregate() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.aggregate", false]], "aggregatefunction (in module datafusion.expr)": [[4, "datafusion.expr.AggregateFunction", false]], "aggregateudf (class in datafusion)": [[7, "datafusion.AggregateUDF", false]], "aggregateudf (class in datafusion.user_defined)": [[18, "datafusion.user_defined.AggregateUDF", false]], "alias (in module datafusion.expr)": [[4, "datafusion.expr.Alias", false]], "alias() (datafusion.expr method)": [[7, "datafusion.Expr.alias", false]], "alias() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.alias", false]], "alias() (in module datafusion.functions)": [[5, "datafusion.functions.alias", false]], "amazons3 (in module datafusion.object_store)": [[12, "datafusion.object_store.AmazonS3", false]], "analyze (in module datafusion.expr)": [[4, "datafusion.expr.Analyze", false]], "approx_distinct() (in module datafusion.functions)": [[5, "datafusion.functions.approx_distinct", false]], "approx_median() (in module datafusion.functions)": [[5, "datafusion.functions.approx_median", false]], "approx_percentile_cont() (in module datafusion.functions)": [[5, "datafusion.functions.approx_percentile_cont", false]], "approx_percentile_cont_with_weight() (in module datafusion.functions)": [[5, "datafusion.functions.approx_percentile_cont_with_weight", false]], "array() (in module datafusion.functions)": [[5, "datafusion.functions.array", false]], "array_agg() (in module datafusion.functions)": [[5, "datafusion.functions.array_agg", false]], "array_append() (in module datafusion.functions)": [[5, "datafusion.functions.array_append", false]], "array_cat() (in module datafusion.functions)": [[5, "datafusion.functions.array_cat", false]], "array_concat() (in module datafusion.functions)": [[5, "datafusion.functions.array_concat", false]], "array_dims() (datafusion.expr method)": [[7, "datafusion.Expr.array_dims", false]], "array_dims() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.array_dims", false]], "array_dims() (in module datafusion.functions)": [[5, "datafusion.functions.array_dims", false]], "array_distinct() (datafusion.expr method)": [[7, "datafusion.Expr.array_distinct", false]], "array_distinct() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.array_distinct", false]], "array_distinct() (in module datafusion.functions)": [[5, "datafusion.functions.array_distinct", false]], "array_element() (in module datafusion.functions)": [[5, "datafusion.functions.array_element", false]], "array_empty() (datafusion.expr method)": [[7, "datafusion.Expr.array_empty", false]], "array_empty() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.array_empty", false]], "array_empty() (in module datafusion.functions)": [[5, "datafusion.functions.array_empty", false]], "array_except() (in module datafusion.functions)": [[5, "datafusion.functions.array_except", false]], "array_extract() (in module datafusion.functions)": [[5, "datafusion.functions.array_extract", false]], "array_has() (in module datafusion.functions)": [[5, "datafusion.functions.array_has", false]], "array_has_all() (in module datafusion.functions)": [[5, "datafusion.functions.array_has_all", false]], "array_has_any() (in module datafusion.functions)": [[5, "datafusion.functions.array_has_any", false]], "array_indexof() (in module datafusion.functions)": [[5, "datafusion.functions.array_indexof", false]], "array_intersect() (in module datafusion.functions)": [[5, "datafusion.functions.array_intersect", false]], "array_join() (in module datafusion.functions)": [[5, "datafusion.functions.array_join", false]], "array_length() (datafusion.expr method)": [[7, "datafusion.Expr.array_length", false]], "array_length() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.array_length", false]], "array_length() (in module datafusion.functions)": [[5, "datafusion.functions.array_length", false]], "array_ndims() (datafusion.expr method)": [[7, "datafusion.Expr.array_ndims", false]], "array_ndims() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.array_ndims", false]], "array_ndims() (in module datafusion.functions)": [[5, "datafusion.functions.array_ndims", false]], "array_pop_back() (datafusion.expr method)": [[7, "datafusion.Expr.array_pop_back", false]], "array_pop_back() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.array_pop_back", false]], "array_pop_back() (in module datafusion.functions)": [[5, "datafusion.functions.array_pop_back", false]], "array_pop_front() (datafusion.expr method)": [[7, "datafusion.Expr.array_pop_front", false]], "array_pop_front() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.array_pop_front", false]], "array_pop_front() (in module datafusion.functions)": [[5, "datafusion.functions.array_pop_front", false]], "array_position() (in module datafusion.functions)": [[5, "datafusion.functions.array_position", false]], "array_positions() (in module datafusion.functions)": [[5, "datafusion.functions.array_positions", false]], "array_prepend() (in module datafusion.functions)": [[5, "datafusion.functions.array_prepend", false]], "array_push_back() (in module datafusion.functions)": [[5, "datafusion.functions.array_push_back", false]], "array_push_front() (in module datafusion.functions)": [[5, "datafusion.functions.array_push_front", false]], "array_remove() (in module datafusion.functions)": [[5, "datafusion.functions.array_remove", false]], "array_remove_all() (in module datafusion.functions)": [[5, "datafusion.functions.array_remove_all", false]], "array_remove_n() (in module datafusion.functions)": [[5, "datafusion.functions.array_remove_n", false]], "array_repeat() (in module datafusion.functions)": [[5, "datafusion.functions.array_repeat", false]], "array_replace() (in module datafusion.functions)": [[5, "datafusion.functions.array_replace", false]], "array_replace_all() (in module datafusion.functions)": [[5, "datafusion.functions.array_replace_all", false]], "array_replace_n() (in module datafusion.functions)": [[5, "datafusion.functions.array_replace_n", false]], "array_resize() (in module datafusion.functions)": [[5, "datafusion.functions.array_resize", false]], "array_slice() (in module datafusion.functions)": [[5, "datafusion.functions.array_slice", false]], "array_sort() (in module datafusion.functions)": [[5, "datafusion.functions.array_sort", false]], "array_to_string() (in module datafusion.functions)": [[5, "datafusion.functions.array_to_string", false]], "array_union() (in module datafusion.functions)": [[5, "datafusion.functions.array_union", false]], "arrow_cast() (in module datafusion.functions)": [[5, "datafusion.functions.arrow_cast", false]], "arrow_typeof() (datafusion.expr method)": [[7, "datafusion.Expr.arrow_typeof", false]], "arrow_typeof() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.arrow_typeof", false]], "arrow_typeof() (in module datafusion.functions)": [[5, "datafusion.functions.arrow_typeof", false]], "arrowarrayexportable (class in datafusion.context)": [[2, "datafusion.context.ArrowArrayExportable", false]], "arrowstreamexportable (class in datafusion.context)": [[2, "datafusion.context.ArrowStreamExportable", false]], "ascending() (datafusion.expr.sortexpr method)": [[4, "datafusion.expr.SortExpr.ascending", false]], "ascii() (datafusion.expr method)": [[7, "datafusion.Expr.ascii", false]], "ascii() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.ascii", false]], "ascii() (in module datafusion.functions)": [[5, "datafusion.functions.ascii", false]], "asin() (datafusion.expr method)": [[7, "datafusion.Expr.asin", false]], "asin() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.asin", false]], "asin() (in module datafusion.functions)": [[5, "datafusion.functions.asin", false]], "asinh() (datafusion.expr method)": [[7, "datafusion.Expr.asinh", false]], "asinh() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.asinh", false]], "asinh() (in module datafusion.functions)": [[5, "datafusion.functions.asinh", false]], "atan() (datafusion.expr method)": [[7, "datafusion.Expr.atan", false]], "atan() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.atan", false]], "atan() (in module datafusion.functions)": [[5, "datafusion.functions.atan", false]], "atan2() (in module datafusion.functions)": [[5, "datafusion.functions.atan2", false]], "atanh() (datafusion.expr method)": [[7, "datafusion.Expr.atanh", false]], "atanh() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.atanh", false]], "atanh() (in module datafusion.functions)": [[5, "datafusion.functions.atanh", false]], "avg() (in module datafusion.functions)": [[5, "datafusion.functions.avg", false]], "baseinputsource (class in datafusion.input.base)": [[8, "datafusion.input.base.BaseInputSource", false]], "between (in module datafusion.expr)": [[4, "datafusion.expr.Between", false]], "between() (datafusion.expr method)": [[7, "datafusion.Expr.between", false]], "between() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.between", false]], "binaryexpr (in module datafusion.expr)": [[4, "datafusion.expr.BinaryExpr", false]], "bit_and() (in module datafusion.functions)": [[5, "datafusion.functions.bit_and", false]], "bit_length() (datafusion.expr method)": [[7, "datafusion.Expr.bit_length", false]], "bit_length() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.bit_length", false]], "bit_length() (in module datafusion.functions)": [[5, "datafusion.functions.bit_length", false]], "bit_or() (in module datafusion.functions)": [[5, "datafusion.functions.bit_or", false]], "bit_xor() (in module datafusion.functions)": [[5, "datafusion.functions.bit_xor", false]], "bool_and() (in module datafusion.functions)": [[5, "datafusion.functions.bool_and", false]], "bool_or() (in module datafusion.functions)": [[5, "datafusion.functions.bool_or", false]], "brotli (datafusion.dataframe.compression attribute)": [[3, "datafusion.dataframe.Compression.BROTLI", false]], "btrim() (datafusion.expr method)": [[7, "datafusion.Expr.btrim", false]], "btrim() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.btrim", false]], "btrim() (in module datafusion.functions)": [[5, "datafusion.functions.btrim", false]], "build_table() (datafusion.input.base.baseinputsource method)": [[8, "datafusion.input.base.BaseInputSource.build_table", false]], "build_table() (datafusion.input.location.locationinputplugin method)": [[10, "datafusion.input.location.LocationInputPlugin.build_table", false]], "build_table() (datafusion.input.locationinputplugin method)": [[9, "datafusion.input.LocationInputPlugin.build_table", false]], "cache() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.cache", false]], "canonical_name() (datafusion.expr method)": [[7, "datafusion.Expr.canonical_name", false]], "canonical_name() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.canonical_name", false]], "cardinality() (datafusion.expr method)": [[7, "datafusion.Expr.cardinality", false]], "cardinality() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.cardinality", false]], "cardinality() (in module datafusion.functions)": [[5, "datafusion.functions.cardinality", false]], "case (in module datafusion.expr)": [[4, "datafusion.expr.Case", false]], "case() (in module datafusion.functions)": [[5, "datafusion.functions.case", false]], "case_builder (datafusion.expr.casebuilder attribute)": [[4, "datafusion.expr.CaseBuilder.case_builder", false]], "casebuilder (class in datafusion.expr)": [[4, "datafusion.expr.CaseBuilder", false]], "cast (in module datafusion.expr)": [[4, "datafusion.expr.Cast", false]], "cast() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.cast", false]], "cast() (datafusion.expr method)": [[7, "datafusion.Expr.cast", false]], "cast() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.cast", false]], "catalog (class in datafusion)": [[7, "datafusion.Catalog", false]], "catalog (class in datafusion.catalog)": [[0, "datafusion.catalog.Catalog", false]], "catalog (datafusion.catalog attribute)": [[7, "datafusion.Catalog.catalog", false]], "catalog (datafusion.catalog.catalog attribute)": [[0, "datafusion.catalog.Catalog.catalog", false]], "catalog() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.catalog", false]], "cbrt() (datafusion.expr method)": [[7, "datafusion.Expr.cbrt", false]], "cbrt() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.cbrt", false]], "cbrt() (in module datafusion.functions)": [[5, "datafusion.functions.cbrt", false]], "ceil() (datafusion.expr method)": [[7, "datafusion.Expr.ceil", false]], "ceil() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.ceil", false]], "ceil() (in module datafusion.functions)": [[5, "datafusion.functions.ceil", false]], "cellformatter (class in datafusion.html_formatter)": [[6, "datafusion.html_formatter.CellFormatter", false]], "char_length() (datafusion.expr method)": [[7, "datafusion.Expr.char_length", false]], "char_length() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.char_length", false]], "char_length() (in module datafusion.functions)": [[5, "datafusion.functions.char_length", false]], "character_length() (datafusion.expr method)": [[7, "datafusion.Expr.character_length", false]], "character_length() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.character_length", false]], "character_length() (in module datafusion.functions)": [[5, "datafusion.functions.character_length", false]], "children() (datafusion.executionplan method)": [[7, "datafusion.ExecutionPlan.children", false]], "children() (datafusion.plan.executionplan method)": [[13, "datafusion.plan.ExecutionPlan.children", false]], "chr() (datafusion.expr method)": [[7, "datafusion.Expr.chr", false]], "chr() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.chr", false]], "chr() (in module datafusion.functions)": [[5, "datafusion.functions.chr", false]], "coalesce() (in module datafusion.functions)": [[5, "datafusion.functions.coalesce", false]], "col (in module datafusion)": [[7, "datafusion.col", false]], "col (in module datafusion.col)": [[1, "datafusion.col.col", false]], "col() (in module datafusion.functions)": [[5, "datafusion.functions.col", false]], "collect() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.collect", false]], "collect_partitioned() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.collect_partitioned", false]], "column (in module datafusion)": [[7, "datafusion.column", false]], "column (in module datafusion.col)": [[1, "datafusion.col.column", false]], "column (in module datafusion.expr)": [[4, "datafusion.expr.Column", false]], "column() (datafusion.expr static method)": [[7, "datafusion.Expr.column", false]], "column() (datafusion.expr.expr static method)": [[4, "datafusion.expr.Expr.column", false]], "column_name() (datafusion.expr method)": [[7, "datafusion.Expr.column_name", false]], "column_name() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.column_name", false]], "compression (class in datafusion.dataframe)": [[3, "datafusion.dataframe.Compression", false]], "concat() (in module datafusion.functions)": [[5, "datafusion.functions.concat", false]], "concat_ws() (in module datafusion.functions)": [[5, "datafusion.functions.concat_ws", false]], "config_internal (datafusion.context.runtimeenvbuilder attribute)": [[2, "datafusion.context.RuntimeEnvBuilder.config_internal", false]], "config_internal (datafusion.context.sessionconfig attribute)": [[2, "datafusion.context.SessionConfig.config_internal", false]], "config_internal (datafusion.runtimeenvbuilder attribute)": [[7, "datafusion.RuntimeEnvBuilder.config_internal", false]], "config_internal (datafusion.sessionconfig attribute)": [[7, "datafusion.SessionConfig.config_internal", false]], "configure_formatter() (in module datafusion)": [[7, "datafusion.configure_formatter", false]], "configure_formatter() (in module datafusion.html_formatter)": [[6, "datafusion.html_formatter.configure_formatter", false]], "consumer (class in datafusion.substrait)": [[15, "datafusion.substrait.Consumer", false]], "copyto (in module datafusion.expr)": [[4, "datafusion.expr.CopyTo", false]], "corr() (in module datafusion.functions)": [[5, "datafusion.functions.corr", false]], "cos() (datafusion.expr method)": [[7, "datafusion.Expr.cos", false]], "cos() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.cos", false]], "cos() (in module datafusion.functions)": [[5, "datafusion.functions.cos", false]], "cosh() (datafusion.expr method)": [[7, "datafusion.Expr.cosh", false]], "cosh() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.cosh", false]], "cosh() (in module datafusion.functions)": [[5, "datafusion.functions.cosh", false]], "cot() (datafusion.expr method)": [[7, "datafusion.Expr.cot", false]], "cot() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.cot", false]], "cot() (in module datafusion.functions)": [[5, "datafusion.functions.cot", false]], "count() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.count", false]], "count() (in module datafusion.functions)": [[5, "datafusion.functions.count", false]], "count_star() (in module datafusion.functions)": [[5, "datafusion.functions.count_star", false]], "covar() (in module datafusion.functions)": [[5, "datafusion.functions.covar", false]], "covar_pop() (in module datafusion.functions)": [[5, "datafusion.functions.covar_pop", false]], "covar_samp() (in module datafusion.functions)": [[5, "datafusion.functions.covar_samp", false]], "create_dataframe() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.create_dataframe", false]], "create_dataframe_from_logical_plan() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.create_dataframe_from_logical_plan", false]], "createcatalog (in module datafusion.expr)": [[4, "datafusion.expr.CreateCatalog", false]], "createcatalogschema (in module datafusion.expr)": [[4, "datafusion.expr.CreateCatalogSchema", false]], "createexternaltable (in module datafusion.expr)": [[4, "datafusion.expr.CreateExternalTable", false]], "createfunction (in module datafusion.expr)": [[4, "datafusion.expr.CreateFunction", false]], "createfunctionbody (in module datafusion.expr)": [[4, "datafusion.expr.CreateFunctionBody", false]], "createindex (in module datafusion.expr)": [[4, "datafusion.expr.CreateIndex", false]], "creatememorytable (in module datafusion.expr)": [[4, "datafusion.expr.CreateMemoryTable", false]], "createview (in module datafusion.expr)": [[4, "datafusion.expr.CreateView", false]], "ctx (datafusion.context.sessioncontext attribute)": [[2, "datafusion.context.SessionContext.ctx", false]], "cume_dist() (in module datafusion.functions)": [[5, "datafusion.functions.cume_dist", false]], "current_date() (in module datafusion.functions)": [[5, "datafusion.functions.current_date", false]], "current_time() (in module datafusion.functions)": [[5, "datafusion.functions.current_time", false]], "custom_css (datafusion.html_formatter.dataframehtmlformatter attribute)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter.custom_css", false]], "database (class in datafusion)": [[7, "datafusion.Database", false]], "database (class in datafusion.catalog)": [[0, "datafusion.catalog.Database", false]], "database() (datafusion.catalog method)": [[7, "datafusion.Catalog.database", false]], "database() (datafusion.catalog.catalog method)": [[0, "datafusion.catalog.Catalog.database", false]], "dataframe (class in datafusion.dataframe)": [[3, "datafusion.dataframe.DataFrame", false]], "dataframehtmlformatter (class in datafusion.html_formatter)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter", false]], "datafusion": [[7, "module-datafusion", false]], "datafusion.catalog": [[0, "module-datafusion.catalog", false]], "datafusion.col": [[1, "module-datafusion.col", false]], "datafusion.context": [[2, "module-datafusion.context", false]], "datafusion.dataframe": [[3, "module-datafusion.dataframe", false]], "datafusion.expr": [[4, "module-datafusion.expr", false]], "datafusion.functions": [[5, "module-datafusion.functions", false]], "datafusion.html_formatter": [[6, "module-datafusion.html_formatter", false]], "datafusion.input": [[9, "module-datafusion.input", false]], "datafusion.input.base": [[8, "module-datafusion.input.base", false]], "datafusion.input.location": [[10, "module-datafusion.input.location", false]], "datafusion.io": [[11, "module-datafusion.io", false]], "datafusion.object_store": [[12, "module-datafusion.object_store", false]], "datafusion.plan": [[13, "module-datafusion.plan", false]], "datafusion.record_batch": [[14, "module-datafusion.record_batch", false]], "datafusion.substrait": [[15, "module-datafusion.substrait", false]], "datafusion.udf": [[16, "module-datafusion.udf", false]], "datafusion.unparser": [[17, "module-datafusion.unparser", false]], "datafusion.user_defined": [[18, "module-datafusion.user_defined", false]], "date_bin() (in module datafusion.functions)": [[5, "datafusion.functions.date_bin", false]], "date_part() (in module datafusion.functions)": [[5, "datafusion.functions.date_part", false]], "date_trunc() (in module datafusion.functions)": [[5, "datafusion.functions.date_trunc", false]], "datepart() (in module datafusion.functions)": [[5, "datafusion.functions.datepart", false]], "datetrunc() (in module datafusion.functions)": [[5, "datafusion.functions.datetrunc", false]], "db (datafusion.catalog.database attribute)": [[0, "datafusion.catalog.Database.db", false]], "db (datafusion.database attribute)": [[7, "datafusion.Database.db", false]], "deallocate (in module datafusion.expr)": [[4, "datafusion.expr.Deallocate", false]], "decode() (in module datafusion.functions)": [[5, "datafusion.functions.decode", false]], "default() (datafusion.unparser.dialect static method)": [[17, "datafusion.unparser.Dialect.default", false]], "defaultstyleprovider (class in datafusion.html_formatter)": [[6, "datafusion.html_formatter.DefaultStyleProvider", false]], "degrees() (datafusion.expr method)": [[7, "datafusion.Expr.degrees", false]], "degrees() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.degrees", false]], "degrees() (in module datafusion.functions)": [[5, "datafusion.functions.degrees", false]], "dense_rank() (in module datafusion.functions)": [[5, "datafusion.functions.dense_rank", false]], "deregister_table() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.deregister_table", false]], "describe() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.describe", false]], "describetable (in module datafusion.expr)": [[4, "datafusion.expr.DescribeTable", false]], "deserialize() (datafusion.substrait.serde static method)": [[15, "datafusion.substrait.Serde.deserialize", false]], "deserialize_bytes() (datafusion.substrait.serde static method)": [[15, "datafusion.substrait.Serde.deserialize_bytes", false]], "df (datafusion.dataframe.dataframe attribute)": [[3, "datafusion.dataframe.DataFrame.df", false]], "dfschema (in module datafusion)": [[7, "datafusion.DFSchema", false]], "dialect (class in datafusion.unparser)": [[17, "datafusion.unparser.Dialect", false]], "dialect (datafusion.unparser.dialect attribute)": [[17, "datafusion.unparser.Dialect.dialect", false]], "digest() (in module datafusion.functions)": [[5, "datafusion.functions.digest", false]], "display() (datafusion.executionplan method)": [[7, "datafusion.ExecutionPlan.display", false]], "display() (datafusion.logicalplan method)": [[7, "datafusion.LogicalPlan.display", false]], "display() (datafusion.plan.executionplan method)": [[13, "datafusion.plan.ExecutionPlan.display", false]], "display() (datafusion.plan.logicalplan method)": [[13, "datafusion.plan.LogicalPlan.display", false]], "display_graphviz() (datafusion.logicalplan method)": [[7, "datafusion.LogicalPlan.display_graphviz", false]], "display_graphviz() (datafusion.plan.logicalplan method)": [[13, "datafusion.plan.LogicalPlan.display_graphviz", false]], "display_indent() (datafusion.executionplan method)": [[7, "datafusion.ExecutionPlan.display_indent", false]], "display_indent() (datafusion.logicalplan method)": [[7, "datafusion.LogicalPlan.display_indent", false]], "display_indent() (datafusion.plan.executionplan method)": [[13, "datafusion.plan.ExecutionPlan.display_indent", false]], "display_indent() (datafusion.plan.logicalplan method)": [[13, "datafusion.plan.LogicalPlan.display_indent", false]], "display_indent_schema() (datafusion.logicalplan method)": [[7, "datafusion.LogicalPlan.display_indent_schema", false]], "display_indent_schema() (datafusion.plan.logicalplan method)": [[13, "datafusion.plan.LogicalPlan.display_indent_schema", false]], "display_name() (datafusion.expr method)": [[7, "datafusion.Expr.display_name", false]], "display_name() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.display_name", false]], "distinct (in module datafusion.expr)": [[4, "datafusion.expr.Distinct", false]], "distinct() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.distinct", false]], "distinct() (datafusion.expr method)": [[7, "datafusion.Expr.distinct", false]], "distinct() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.distinct", false]], "dmlstatement (in module datafusion.expr)": [[4, "datafusion.expr.DmlStatement", false]], "drop() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.drop", false]], "dropcatalogschema (in module datafusion.expr)": [[4, "datafusion.expr.DropCatalogSchema", false]], "dropfunction (in module datafusion.expr)": [[4, "datafusion.expr.DropFunction", false]], "droptable (in module datafusion.expr)": [[4, "datafusion.expr.DropTable", false]], "dropview (in module datafusion.expr)": [[4, "datafusion.expr.DropView", false]], "duckdb() (datafusion.unparser.dialect static method)": [[17, "datafusion.unparser.Dialect.duckdb", false]], "empty() (datafusion.expr method)": [[7, "datafusion.Expr.empty", false]], "empty() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.empty", false]], "empty() (in module datafusion.functions)": [[5, "datafusion.functions.empty", false]], "empty_table() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.empty_table", false]], "emptyrelation (in module datafusion.expr)": [[4, "datafusion.expr.EmptyRelation", false]], "enable_cell_expansion (datafusion.html_formatter.dataframehtmlformatter attribute)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter.enable_cell_expansion", false]], "enable_url_table() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.enable_url_table", false]], "encode() (datafusion.substrait.plan method)": [[15, "datafusion.substrait.Plan.encode", false]], "encode() (in module datafusion.functions)": [[5, "datafusion.functions.encode", false]], "end() (datafusion.expr.casebuilder method)": [[4, "datafusion.expr.CaseBuilder.end", false]], "ends_with() (in module datafusion.functions)": [[5, "datafusion.functions.ends_with", false]], "evaluate() (datafusion.accumulator method)": [[7, "datafusion.Accumulator.evaluate", false]], "evaluate() (datafusion.user_defined.accumulator method)": [[18, "datafusion.user_defined.Accumulator.evaluate", false]], "evaluate() (datafusion.user_defined.windowevaluator method)": [[18, "datafusion.user_defined.WindowEvaluator.evaluate", false]], "evaluate_all() (datafusion.user_defined.windowevaluator method)": [[18, "datafusion.user_defined.WindowEvaluator.evaluate_all", false]], "evaluate_all_with_rank() (datafusion.user_defined.windowevaluator method)": [[18, "datafusion.user_defined.WindowEvaluator.evaluate_all_with_rank", false]], "except_all() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.except_all", false]], "execute (in module datafusion.expr)": [[4, "datafusion.expr.Execute", false]], "execute() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.execute", false]], "execute_stream() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.execute_stream", false]], "execute_stream_partitioned() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.execute_stream_partitioned", false]], "execution_plan() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.execution_plan", false]], "executionplan (class in datafusion)": [[7, "datafusion.ExecutionPlan", false]], "executionplan (class in datafusion.plan)": [[13, "datafusion.plan.ExecutionPlan", false]], "exists (in module datafusion.expr)": [[4, "datafusion.expr.Exists", false]], "exp() (datafusion.expr method)": [[7, "datafusion.Expr.exp", false]], "exp() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.exp", false]], "exp() (in module datafusion.functions)": [[5, "datafusion.functions.exp", false]], "explain (in module datafusion.expr)": [[4, "datafusion.expr.Explain", false]], "explain() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.explain", false]], "expr (class in datafusion)": [[7, "datafusion.Expr", false]], "expr (class in datafusion.expr)": [[4, "datafusion.expr.Expr", false]], "expr (datafusion.expr attribute)": [[7, "datafusion.Expr.expr", false]], "expr (datafusion.expr.expr attribute)": [[4, "datafusion.expr.Expr.expr", false]], "expr() (datafusion.expr.sortexpr method)": [[4, "datafusion.expr.SortExpr.expr", false]], "extension (in module datafusion.expr)": [[4, "datafusion.expr.Extension", false]], "extract() (in module datafusion.functions)": [[5, "datafusion.functions.extract", false]], "factorial() (datafusion.expr method)": [[7, "datafusion.Expr.factorial", false]], "factorial() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.factorial", false]], "factorial() (in module datafusion.functions)": [[5, "datafusion.functions.factorial", false]], "filetype (in module datafusion.expr)": [[4, "datafusion.expr.FileType", false]], "fill_nan() (datafusion.expr method)": [[7, "datafusion.Expr.fill_nan", false]], "fill_nan() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.fill_nan", false]], "fill_null() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.fill_null", false]], "fill_null() (datafusion.expr method)": [[7, "datafusion.Expr.fill_null", false]], "fill_null() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.fill_null", false]], "filter (in module datafusion.expr)": [[4, "datafusion.expr.Filter", false]], "filter() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.filter", false]], "filter() (datafusion.expr method)": [[7, "datafusion.Expr.filter", false]], "filter() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.filter", false]], "find_in_set() (in module datafusion.functions)": [[5, "datafusion.functions.find_in_set", false]], "first_value() (in module datafusion.functions)": [[5, "datafusion.functions.first_value", false]], "flatten() (datafusion.expr method)": [[7, "datafusion.Expr.flatten", false]], "flatten() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.flatten", false]], "flatten() (in module datafusion.functions)": [[5, "datafusion.functions.flatten", false]], "floor() (datafusion.expr method)": [[7, "datafusion.Expr.floor", false]], "floor() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.floor", false]], "floor() (in module datafusion.functions)": [[5, "datafusion.functions.floor", false]], "format_html() (datafusion.html_formatter.dataframehtmlformatter method)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter.format_html", false]], "formattermanager (class in datafusion.html_formatter)": [[6, "datafusion.html_formatter.FormatterManager", false]], "frame_bound (datafusion.expr.windowframebound attribute)": [[4, "datafusion.expr.WindowFrameBound.frame_bound", false]], "from_arrow() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.from_arrow", false]], "from_arrow_table() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.from_arrow_table", false]], "from_pandas() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.from_pandas", false]], "from_polars() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.from_polars", false]], "from_proto() (datafusion.executionplan static method)": [[7, "datafusion.ExecutionPlan.from_proto", false]], "from_proto() (datafusion.logicalplan static method)": [[7, "datafusion.LogicalPlan.from_proto", false]], "from_proto() (datafusion.plan.executionplan static method)": [[13, "datafusion.plan.ExecutionPlan.from_proto", false]], "from_proto() (datafusion.plan.logicalplan static method)": [[13, "datafusion.plan.LogicalPlan.from_proto", false]], "from_pydict() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.from_pydict", false]], "from_pylist() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.from_pylist", false]], "from_str() (datafusion.dataframe.compression class method)": [[3, "datafusion.dataframe.Compression.from_str", false]], "from_substrait_plan() (datafusion.substrait.consumer static method)": [[15, "datafusion.substrait.Consumer.from_substrait_plan", false]], "from_unixtime() (datafusion.expr method)": [[7, "datafusion.Expr.from_unixtime", false]], "from_unixtime() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.from_unixtime", false]], "from_unixtime() (in module datafusion.functions)": [[5, "datafusion.functions.from_unixtime", false]], "gcd() (in module datafusion.functions)": [[5, "datafusion.functions.gcd", false]], "get_cell_style() (datafusion.html_formatter.defaultstyleprovider method)": [[6, "datafusion.html_formatter.DefaultStyleProvider.get_cell_style", false]], "get_cell_style() (datafusion.html_formatter.styleprovider method)": [[6, "datafusion.html_formatter.StyleProvider.get_cell_style", false]], "get_default_level() (datafusion.dataframe.compression method)": [[3, "datafusion.dataframe.Compression.get_default_level", false]], "get_formatter() (datafusion.html_formatter.formattermanager class method)": [[6, "datafusion.html_formatter.FormatterManager.get_formatter", false]], "get_formatter() (in module datafusion.html_formatter)": [[6, "datafusion.html_formatter.get_formatter", false]], "get_frame_units() (datafusion.expr.windowframe method)": [[4, "datafusion.expr.WindowFrame.get_frame_units", false]], "get_frame_units() (datafusion.windowframe method)": [[7, "datafusion.WindowFrame.get_frame_units", false]], "get_header_style() (datafusion.html_formatter.defaultstyleprovider method)": [[6, "datafusion.html_formatter.DefaultStyleProvider.get_header_style", false]], "get_header_style() (datafusion.html_formatter.styleprovider method)": [[6, "datafusion.html_formatter.StyleProvider.get_header_style", false]], "get_lower_bound() (datafusion.expr.windowframe method)": [[4, "datafusion.expr.WindowFrame.get_lower_bound", false]], "get_lower_bound() (datafusion.windowframe method)": [[7, "datafusion.WindowFrame.get_lower_bound", false]], "get_offset() (datafusion.expr.windowframebound method)": [[4, "datafusion.expr.WindowFrameBound.get_offset", false]], "get_range() (datafusion.user_defined.windowevaluator method)": [[18, "datafusion.user_defined.WindowEvaluator.get_range", false]], "get_upper_bound() (datafusion.expr.windowframe method)": [[4, "datafusion.expr.WindowFrame.get_upper_bound", false]], "get_upper_bound() (datafusion.windowframe method)": [[7, "datafusion.WindowFrame.get_upper_bound", false]], "global_ctx() (datafusion.context.sessioncontext class method)": [[2, "datafusion.context.SessionContext.global_ctx", false]], "googlecloud (in module datafusion.object_store)": [[12, "datafusion.object_store.GoogleCloud", false]], "groupingset (in module datafusion.expr)": [[4, "datafusion.expr.GroupingSet", false]], "gzip (datafusion.dataframe.compression attribute)": [[3, "datafusion.dataframe.Compression.GZIP", false]], "head() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.head", false]], "http (in module datafusion.object_store)": [[12, "datafusion.object_store.Http", false]], "ilike (in module datafusion.expr)": [[4, "datafusion.expr.ILike", false]], "immutable (datafusion.user_defined.volatility attribute)": [[18, "datafusion.user_defined.Volatility.Immutable", false]], "in_list() (in module datafusion.functions)": [[5, "datafusion.functions.in_list", false]], "include_rank() (datafusion.user_defined.windowevaluator method)": [[18, "datafusion.user_defined.WindowEvaluator.include_rank", false]], "initcap() (datafusion.expr method)": [[7, "datafusion.Expr.initcap", false]], "initcap() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.initcap", false]], "initcap() (in module datafusion.functions)": [[5, "datafusion.functions.initcap", false]], "inlist (in module datafusion.expr)": [[4, "datafusion.expr.InList", false]], "inputs() (datafusion.logicalplan method)": [[7, "datafusion.LogicalPlan.inputs", false]], "inputs() (datafusion.plan.logicalplan method)": [[13, "datafusion.plan.LogicalPlan.inputs", false]], "insubquery (in module datafusion.expr)": [[4, "datafusion.expr.InSubquery", false]], "intersect() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.intersect", false]], "into_view() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.into_view", false]], "is_causal() (datafusion.user_defined.windowevaluator method)": [[18, "datafusion.user_defined.WindowEvaluator.is_causal", false]], "is_correct_input() (datafusion.input.base.baseinputsource method)": [[8, "datafusion.input.base.BaseInputSource.is_correct_input", false]], "is_correct_input() (datafusion.input.location.locationinputplugin method)": [[10, "datafusion.input.location.LocationInputPlugin.is_correct_input", false]], "is_correct_input() (datafusion.input.locationinputplugin method)": [[9, "datafusion.input.LocationInputPlugin.is_correct_input", false]], "is_current_row() (datafusion.expr.windowframebound method)": [[4, "datafusion.expr.WindowFrameBound.is_current_row", false]], "is_following() (datafusion.expr.windowframebound method)": [[4, "datafusion.expr.WindowFrameBound.is_following", false]], "is_not_null() (datafusion.expr method)": [[7, "datafusion.Expr.is_not_null", false]], "is_not_null() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.is_not_null", false]], "is_null() (datafusion.expr method)": [[7, "datafusion.Expr.is_null", false]], "is_null() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.is_null", false]], "is_preceding() (datafusion.expr.windowframebound method)": [[4, "datafusion.expr.WindowFrameBound.is_preceding", false]], "is_styles_loaded() (datafusion.html_formatter.dataframehtmlformatter class method)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter.is_styles_loaded", false]], "is_unbounded() (datafusion.expr.windowframebound method)": [[4, "datafusion.expr.WindowFrameBound.is_unbounded", false]], "isfalse (in module datafusion.expr)": [[4, "datafusion.expr.IsFalse", false]], "isnan() (datafusion.expr method)": [[7, "datafusion.Expr.isnan", false]], "isnan() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.isnan", false]], "isnan() (in module datafusion.functions)": [[5, "datafusion.functions.isnan", false]], "isnotfalse (in module datafusion.expr)": [[4, "datafusion.expr.IsNotFalse", false]], "isnotnull (in module datafusion.expr)": [[4, "datafusion.expr.IsNotNull", false]], "isnottrue (in module datafusion.expr)": [[4, "datafusion.expr.IsNotTrue", false]], "isnotunknown (in module datafusion.expr)": [[4, "datafusion.expr.IsNotUnknown", false]], "isnull (in module datafusion.expr)": [[4, "datafusion.expr.IsNull", false]], "istrue (in module datafusion.expr)": [[4, "datafusion.expr.IsTrue", false]], "isunknown (in module datafusion.expr)": [[4, "datafusion.expr.IsUnknown", false]], "iszero() (datafusion.expr method)": [[7, "datafusion.Expr.iszero", false]], "iszero() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.iszero", false]], "iszero() (in module datafusion.functions)": [[5, "datafusion.functions.iszero", false]], "join (in module datafusion.expr)": [[4, "datafusion.expr.Join", false]], "join() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.join", false]], "join_on() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.join_on", false]], "joinconstraint (in module datafusion.expr)": [[4, "datafusion.expr.JoinConstraint", false]], "jointype (in module datafusion.expr)": [[4, "datafusion.expr.JoinType", false]], "kind (datafusion.catalog.table property)": [[0, "datafusion.catalog.Table.kind", false]], "kind (datafusion.table property)": [[7, "datafusion.Table.kind", false]], "lag() (in module datafusion.functions)": [[5, "datafusion.functions.lag", false]], "last_value() (in module datafusion.functions)": [[5, "datafusion.functions.last_value", false]], "lcm() (in module datafusion.functions)": [[5, "datafusion.functions.lcm", false]], "lead() (in module datafusion.functions)": [[5, "datafusion.functions.lead", false]], "left() (in module datafusion.functions)": [[5, "datafusion.functions.left", false]], "length() (datafusion.expr method)": [[7, "datafusion.Expr.length", false]], "length() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.length", false]], "length() (in module datafusion.functions)": [[5, "datafusion.functions.length", false]], "levenshtein() (in module datafusion.functions)": [[5, "datafusion.functions.levenshtein", false]], "like (in module datafusion.expr)": [[4, "datafusion.expr.Like", false]], "limit (in module datafusion.expr)": [[4, "datafusion.expr.Limit", false]], "limit() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.limit", false]], "list_append() (in module datafusion.functions)": [[5, "datafusion.functions.list_append", false]], "list_cat() (in module datafusion.functions)": [[5, "datafusion.functions.list_cat", false]], "list_concat() (in module datafusion.functions)": [[5, "datafusion.functions.list_concat", false]], "list_dims() (datafusion.expr method)": [[7, "datafusion.Expr.list_dims", false]], "list_dims() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.list_dims", false]], "list_dims() (in module datafusion.functions)": [[5, "datafusion.functions.list_dims", false]], "list_distinct() (datafusion.expr method)": [[7, "datafusion.Expr.list_distinct", false]], "list_distinct() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.list_distinct", false]], "list_distinct() (in module datafusion.functions)": [[5, "datafusion.functions.list_distinct", false]], "list_element() (in module datafusion.functions)": [[5, "datafusion.functions.list_element", false]], "list_except() (in module datafusion.functions)": [[5, "datafusion.functions.list_except", false]], "list_extract() (in module datafusion.functions)": [[5, "datafusion.functions.list_extract", false]], "list_indexof() (in module datafusion.functions)": [[5, "datafusion.functions.list_indexof", false]], "list_intersect() (in module datafusion.functions)": [[5, "datafusion.functions.list_intersect", false]], "list_join() (in module datafusion.functions)": [[5, "datafusion.functions.list_join", false]], "list_length() (datafusion.expr method)": [[7, "datafusion.Expr.list_length", false]], "list_length() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.list_length", false]], "list_length() (in module datafusion.functions)": [[5, "datafusion.functions.list_length", false]], "list_ndims() (datafusion.expr method)": [[7, "datafusion.Expr.list_ndims", false]], "list_ndims() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.list_ndims", false]], "list_ndims() (in module datafusion.functions)": [[5, "datafusion.functions.list_ndims", false]], "list_position() (in module datafusion.functions)": [[5, "datafusion.functions.list_position", false]], "list_positions() (in module datafusion.functions)": [[5, "datafusion.functions.list_positions", false]], "list_prepend() (in module datafusion.functions)": [[5, "datafusion.functions.list_prepend", false]], "list_push_back() (in module datafusion.functions)": [[5, "datafusion.functions.list_push_back", false]], "list_push_front() (in module datafusion.functions)": [[5, "datafusion.functions.list_push_front", false]], "list_remove() (in module datafusion.functions)": [[5, "datafusion.functions.list_remove", false]], "list_remove_all() (in module datafusion.functions)": [[5, "datafusion.functions.list_remove_all", false]], "list_remove_n() (in module datafusion.functions)": [[5, "datafusion.functions.list_remove_n", false]], "list_repeat() (in module datafusion.functions)": [[5, "datafusion.functions.list_repeat", false]], "list_replace() (in module datafusion.functions)": [[5, "datafusion.functions.list_replace", false]], "list_replace_all() (in module datafusion.functions)": [[5, "datafusion.functions.list_replace_all", false]], "list_replace_n() (in module datafusion.functions)": [[5, "datafusion.functions.list_replace_n", false]], "list_resize() (in module datafusion.functions)": [[5, "datafusion.functions.list_resize", false]], "list_slice() (in module datafusion.functions)": [[5, "datafusion.functions.list_slice", false]], "list_sort() (in module datafusion.functions)": [[5, "datafusion.functions.list_sort", false]], "list_to_string() (in module datafusion.functions)": [[5, "datafusion.functions.list_to_string", false]], "list_union() (in module datafusion.functions)": [[5, "datafusion.functions.list_union", false]], "lit() (in module datafusion)": [[7, "datafusion.lit", false]], "literal (in module datafusion.expr)": [[4, "datafusion.expr.Literal", false]], "literal() (datafusion.expr static method)": [[7, "datafusion.Expr.literal", false]], "literal() (datafusion.expr.expr static method)": [[4, "datafusion.expr.Expr.literal", false]], "literal() (in module datafusion)": [[7, "datafusion.literal", false]], "ln() (datafusion.expr method)": [[7, "datafusion.Expr.ln", false]], "ln() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.ln", false]], "ln() (in module datafusion.functions)": [[5, "datafusion.functions.ln", false]], "localfilesystem (in module datafusion.object_store)": [[12, "datafusion.object_store.LocalFileSystem", false]], "locationinputplugin (class in datafusion.input)": [[9, "datafusion.input.LocationInputPlugin", false]], "locationinputplugin (class in datafusion.input.location)": [[10, "datafusion.input.location.LocationInputPlugin", false]], "log() (in module datafusion.functions)": [[5, "datafusion.functions.log", false]], "log10() (datafusion.expr method)": [[7, "datafusion.Expr.log10", false]], "log10() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.log10", false]], "log10() (in module datafusion.functions)": [[5, "datafusion.functions.log10", false]], "log2() (datafusion.expr method)": [[7, "datafusion.Expr.log2", false]], "log2() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.log2", false]], "log2() (in module datafusion.functions)": [[5, "datafusion.functions.log2", false]], "logical_plan() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.logical_plan", false]], "logicalplan (class in datafusion)": [[7, "datafusion.LogicalPlan", false]], "logicalplan (class in datafusion.plan)": [[13, "datafusion.plan.LogicalPlan", false]], "lower() (datafusion.expr method)": [[7, "datafusion.Expr.lower", false]], "lower() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.lower", false]], "lower() (in module datafusion.functions)": [[5, "datafusion.functions.lower", false]], "lpad() (in module datafusion.functions)": [[5, "datafusion.functions.lpad", false]], "ltrim() (datafusion.expr method)": [[7, "datafusion.Expr.ltrim", false]], "ltrim() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.ltrim", false]], "ltrim() (in module datafusion.functions)": [[5, "datafusion.functions.ltrim", false]], "lz4 (datafusion.dataframe.compression attribute)": [[3, "datafusion.dataframe.Compression.LZ4", false]], "lz4_raw (datafusion.dataframe.compression attribute)": [[3, "datafusion.dataframe.Compression.LZ4_RAW", false]], "make_array() (in module datafusion.functions)": [[5, "datafusion.functions.make_array", false]], "make_date() (in module datafusion.functions)": [[5, "datafusion.functions.make_date", false]], "make_list() (in module datafusion.functions)": [[5, "datafusion.functions.make_list", false]], "max() (in module datafusion.functions)": [[5, "datafusion.functions.max", false]], "max_cell_length (datafusion.html_formatter.dataframehtmlformatter attribute)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter.max_cell_length", false]], "max_height (datafusion.html_formatter.dataframehtmlformatter attribute)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter.max_height", false]], "max_memory_bytes (datafusion.html_formatter.dataframehtmlformatter attribute)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter.max_memory_bytes", false]], "max_width (datafusion.html_formatter.dataframehtmlformatter attribute)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter.max_width", false]], "md5() (datafusion.expr method)": [[7, "datafusion.Expr.md5", false]], "md5() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.md5", false]], "md5() (in module datafusion.functions)": [[5, "datafusion.functions.md5", false]], "mean() (in module datafusion.functions)": [[5, "datafusion.functions.mean", false]], "median() (in module datafusion.functions)": [[5, "datafusion.functions.median", false]], "memoize() (datafusion.user_defined.windowevaluator method)": [[18, "datafusion.user_defined.WindowEvaluator.memoize", false]], "merge() (datafusion.accumulator method)": [[7, "datafusion.Accumulator.merge", false]], "merge() (datafusion.user_defined.accumulator method)": [[18, "datafusion.user_defined.Accumulator.merge", false]], "microsoftazure (in module datafusion.object_store)": [[12, "datafusion.object_store.MicrosoftAzure", false]], "min() (in module datafusion.functions)": [[5, "datafusion.functions.min", false]], "min_rows_display (datafusion.html_formatter.dataframehtmlformatter attribute)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter.min_rows_display", false]], "module": [[0, "module-datafusion.catalog", false], [1, "module-datafusion.col", false], [2, "module-datafusion.context", false], [3, "module-datafusion.dataframe", false], [4, "module-datafusion.expr", false], [5, "module-datafusion.functions", false], [6, "module-datafusion.html_formatter", false], [7, "module-datafusion", false], [8, "module-datafusion.input.base", false], [9, "module-datafusion.input", false], [10, "module-datafusion.input.location", false], [11, "module-datafusion.io", false], [12, "module-datafusion.object_store", false], [13, "module-datafusion.plan", false], [14, "module-datafusion.record_batch", false], [15, "module-datafusion.substrait", false], [16, "module-datafusion.udf", false], [17, "module-datafusion.unparser", false], [18, "module-datafusion.user_defined", false]], "mysql() (datafusion.unparser.dialect static method)": [[17, "datafusion.unparser.Dialect.mysql", false]], "named_struct() (in module datafusion.functions)": [[5, "datafusion.functions.named_struct", false]], "names() (datafusion.catalog method)": [[7, "datafusion.Catalog.names", false]], "names() (datafusion.catalog.catalog method)": [[0, "datafusion.catalog.Catalog.names", false]], "names() (datafusion.catalog.database method)": [[0, "datafusion.catalog.Database.names", false]], "names() (datafusion.database method)": [[7, "datafusion.Database.names", false]], "nanvl() (in module datafusion.functions)": [[5, "datafusion.functions.nanvl", false]], "negative (in module datafusion.expr)": [[4, "datafusion.expr.Negative", false]], "next() (datafusion.record_batch.recordbatchstream method)": [[14, "datafusion.record_batch.RecordBatchStream.next", false]], "next() (datafusion.recordbatchstream method)": [[7, "datafusion.RecordBatchStream.next", false]], "not (in module datafusion.expr)": [[4, "datafusion.expr.Not", false]], "now() (in module datafusion.functions)": [[5, "datafusion.functions.now", false]], "nth_value() (in module datafusion.functions)": [[5, "datafusion.functions.nth_value", false]], "ntile() (in module datafusion.functions)": [[5, "datafusion.functions.ntile", false]], "null_treatment() (datafusion.expr method)": [[7, "datafusion.Expr.null_treatment", false]], "null_treatment() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.null_treatment", false]], "nullif() (in module datafusion.functions)": [[5, "datafusion.functions.nullif", false]], "nulls_first() (datafusion.expr.sortexpr method)": [[4, "datafusion.expr.SortExpr.nulls_first", false]], "nvl() (in module datafusion.functions)": [[5, "datafusion.functions.nvl", false]], "octet_length() (datafusion.expr method)": [[7, "datafusion.Expr.octet_length", false]], "octet_length() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.octet_length", false]], "octet_length() (in module datafusion.functions)": [[5, "datafusion.functions.octet_length", false]], "operatefunctionarg (in module datafusion.expr)": [[4, "datafusion.expr.OperateFunctionArg", false]], "optimized_logical_plan() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.optimized_logical_plan", false]], "options_internal (datafusion.context.sqloptions attribute)": [[2, "datafusion.context.SQLOptions.options_internal", false]], "options_internal (datafusion.sqloptions attribute)": [[7, "datafusion.SQLOptions.options_internal", false]], "order_by() (datafusion.expr method)": [[7, "datafusion.Expr.order_by", false]], "order_by() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.order_by", false]], "order_by() (in module datafusion.functions)": [[5, "datafusion.functions.order_by", false]], "otherwise() (datafusion.expr.casebuilder method)": [[4, "datafusion.expr.CaseBuilder.otherwise", false]], "over() (datafusion.expr method)": [[7, "datafusion.Expr.over", false]], "over() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.over", false]], "overlay() (in module datafusion.functions)": [[5, "datafusion.functions.overlay", false]], "partition_by() (datafusion.expr method)": [[7, "datafusion.Expr.partition_by", false]], "partition_by() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.partition_by", false]], "partition_count (datafusion.executionplan property)": [[7, "datafusion.ExecutionPlan.partition_count", false]], "partition_count (datafusion.plan.executionplan property)": [[13, "datafusion.plan.ExecutionPlan.partition_count", false]], "partitioning (in module datafusion.expr)": [[4, "datafusion.expr.Partitioning", false]], "percent_rank() (in module datafusion.functions)": [[5, "datafusion.functions.percent_rank", false]], "pi() (in module datafusion.functions)": [[5, "datafusion.functions.pi", false]], "placeholder (in module datafusion.expr)": [[4, "datafusion.expr.Placeholder", false]], "plan (class in datafusion.substrait)": [[15, "datafusion.substrait.Plan", false]], "plan_internal (datafusion.substrait.plan attribute)": [[15, "datafusion.substrait.Plan.plan_internal", false]], "plan_to_sql() (datafusion.unparser.unparser method)": [[17, "datafusion.unparser.Unparser.plan_to_sql", false]], "postgres() (datafusion.unparser.dialect static method)": [[17, "datafusion.unparser.Dialect.postgres", false]], "pow() (in module datafusion.functions)": [[5, "datafusion.functions.pow", false]], "power() (in module datafusion.functions)": [[5, "datafusion.functions.power", false]], "prepare (in module datafusion.expr)": [[4, "datafusion.expr.Prepare", false]], "producer (class in datafusion.substrait)": [[15, "datafusion.substrait.Producer", false]], "projection (in module datafusion.expr)": [[4, "datafusion.expr.Projection", false]], "python_value() (datafusion.expr method)": [[7, "datafusion.Expr.python_value", false]], "python_value() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.python_value", false]], "radians() (datafusion.expr method)": [[7, "datafusion.Expr.radians", false]], "radians() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.radians", false]], "radians() (in module datafusion.functions)": [[5, "datafusion.functions.radians", false]], "random() (in module datafusion.functions)": [[5, "datafusion.functions.random", false]], "range() (in module datafusion.functions)": [[5, "datafusion.functions.range", false]], "rank() (in module datafusion.functions)": [[5, "datafusion.functions.rank", false]], "raw_sort (datafusion.expr.sortexpr attribute)": [[4, "datafusion.expr.SortExpr.raw_sort", false]], "rbs (datafusion.record_batch.recordbatchstream attribute)": [[14, "datafusion.record_batch.RecordBatchStream.rbs", false]], "rbs (datafusion.recordbatchstream attribute)": [[7, "datafusion.RecordBatchStream.rbs", false]], "read_avro() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.read_avro", false]], "read_avro() (in module datafusion)": [[7, "datafusion.read_avro", false]], "read_avro() (in module datafusion.io)": [[11, "datafusion.io.read_avro", false]], "read_csv() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.read_csv", false]], "read_csv() (in module datafusion)": [[7, "datafusion.read_csv", false]], "read_csv() (in module datafusion.io)": [[11, "datafusion.io.read_csv", false]], "read_json() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.read_json", false]], "read_json() (in module datafusion)": [[7, "datafusion.read_json", false]], "read_json() (in module datafusion.io)": [[11, "datafusion.io.read_json", false]], "read_parquet() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.read_parquet", false]], "read_parquet() (in module datafusion)": [[7, "datafusion.read_parquet", false]], "read_parquet() (in module datafusion.io)": [[11, "datafusion.io.read_parquet", false]], "read_table() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.read_table", false]], "record_batch (datafusion.record_batch.recordbatch attribute)": [[14, "datafusion.record_batch.RecordBatch.record_batch", false]], "record_batch (datafusion.recordbatch attribute)": [[7, "datafusion.RecordBatch.record_batch", false]], "recordbatch (class in datafusion)": [[7, "datafusion.RecordBatch", false]], "recordbatch (class in datafusion.record_batch)": [[14, "datafusion.record_batch.RecordBatch", false]], "recordbatchstream (class in datafusion)": [[7, "datafusion.RecordBatchStream", false]], "recordbatchstream (class in datafusion.record_batch)": [[14, "datafusion.record_batch.RecordBatchStream", false]], "recursivequery (in module datafusion.expr)": [[4, "datafusion.expr.RecursiveQuery", false]], "regexp_count() (in module datafusion.functions)": [[5, "datafusion.functions.regexp_count", false]], "regexp_like() (in module datafusion.functions)": [[5, "datafusion.functions.regexp_like", false]], "regexp_match() (in module datafusion.functions)": [[5, "datafusion.functions.regexp_match", false]], "regexp_replace() (in module datafusion.functions)": [[5, "datafusion.functions.regexp_replace", false]], "register_avro() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.register_avro", false]], "register_csv() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.register_csv", false]], "register_dataset() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.register_dataset", false]], "register_formatter() (datafusion.html_formatter.dataframehtmlformatter method)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter.register_formatter", false]], "register_json() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.register_json", false]], "register_listing_table() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.register_listing_table", false]], "register_object_store() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.register_object_store", false]], "register_parquet() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.register_parquet", false]], "register_record_batches() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.register_record_batches", false]], "register_table() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.register_table", false]], "register_table_provider() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.register_table_provider", false]], "register_udaf() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.register_udaf", false]], "register_udf() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.register_udf", false]], "register_udtf() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.register_udtf", false]], "register_udwf() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.register_udwf", false]], "register_view() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.register_view", false]], "regr_avgx() (in module datafusion.functions)": [[5, "datafusion.functions.regr_avgx", false]], "regr_avgy() (in module datafusion.functions)": [[5, "datafusion.functions.regr_avgy", false]], "regr_count() (in module datafusion.functions)": [[5, "datafusion.functions.regr_count", false]], "regr_intercept() (in module datafusion.functions)": [[5, "datafusion.functions.regr_intercept", false]], "regr_r2() (in module datafusion.functions)": [[5, "datafusion.functions.regr_r2", false]], "regr_slope() (in module datafusion.functions)": [[5, "datafusion.functions.regr_slope", false]], "regr_sxx() (in module datafusion.functions)": [[5, "datafusion.functions.regr_sxx", false]], "regr_sxy() (in module datafusion.functions)": [[5, "datafusion.functions.regr_sxy", false]], "regr_syy() (in module datafusion.functions)": [[5, "datafusion.functions.regr_syy", false]], "repartition (in module datafusion.expr)": [[4, "datafusion.expr.Repartition", false]], "repartition() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.repartition", false]], "repartition_by_hash() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.repartition_by_hash", false]], "repeat() (in module datafusion.functions)": [[5, "datafusion.functions.repeat", false]], "replace() (in module datafusion.functions)": [[5, "datafusion.functions.replace", false]], "repr_rows (datafusion.html_formatter.dataframehtmlformatter attribute)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter.repr_rows", false]], "reset_formatter() (in module datafusion.html_formatter)": [[6, "datafusion.html_formatter.reset_formatter", false]], "reset_styles_loaded_state() (in module datafusion.html_formatter)": [[6, "datafusion.html_formatter.reset_styles_loaded_state", false]], "reverse() (datafusion.expr method)": [[7, "datafusion.Expr.reverse", false]], "reverse() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.reverse", false]], "reverse() (in module datafusion.functions)": [[5, "datafusion.functions.reverse", false]], "rex_call_operands() (datafusion.expr method)": [[7, "datafusion.Expr.rex_call_operands", false]], "rex_call_operands() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.rex_call_operands", false]], "rex_call_operator() (datafusion.expr method)": [[7, "datafusion.Expr.rex_call_operator", false]], "rex_call_operator() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.rex_call_operator", false]], "rex_type() (datafusion.expr method)": [[7, "datafusion.Expr.rex_type", false]], "rex_type() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.rex_type", false]], "right() (in module datafusion.functions)": [[5, "datafusion.functions.right", false]], "round() (in module datafusion.functions)": [[5, "datafusion.functions.round", false]], "row_number() (in module datafusion.functions)": [[5, "datafusion.functions.row_number", false]], "rpad() (in module datafusion.functions)": [[5, "datafusion.functions.rpad", false]], "rtrim() (datafusion.expr method)": [[7, "datafusion.Expr.rtrim", false]], "rtrim() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.rtrim", false]], "rtrim() (in module datafusion.functions)": [[5, "datafusion.functions.rtrim", false]], "runtimeconfig (class in datafusion.context)": [[2, "datafusion.context.RuntimeConfig", false]], "runtimeenvbuilder (class in datafusion)": [[7, "datafusion.RuntimeEnvBuilder", false]], "runtimeenvbuilder (class in datafusion.context)": [[2, "datafusion.context.RuntimeEnvBuilder", false]], "scalarsubquery (in module datafusion.expr)": [[4, "datafusion.expr.ScalarSubquery", false]], "scalarudf (class in datafusion)": [[7, "datafusion.ScalarUDF", false]], "scalarudf (class in datafusion.user_defined)": [[18, "datafusion.user_defined.ScalarUDF", false]], "scalarvariable (in module datafusion.expr)": [[4, "datafusion.expr.ScalarVariable", false]], "schema (datafusion.catalog.table property)": [[0, "datafusion.catalog.Table.schema", false]], "schema (datafusion.table property)": [[7, "datafusion.Table.schema", false]], "schema() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.schema", false]], "schema_name() (datafusion.expr method)": [[7, "datafusion.Expr.schema_name", false]], "schema_name() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.schema_name", false]], "select() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.select", false]], "select_columns() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.select_columns", false]], "serde (class in datafusion.substrait)": [[15, "datafusion.substrait.Serde", false]], "serialize() (datafusion.substrait.serde static method)": [[15, "datafusion.substrait.Serde.serialize", false]], "serialize_bytes() (datafusion.substrait.serde static method)": [[15, "datafusion.substrait.Serde.serialize_bytes", false]], "serialize_to_plan() (datafusion.substrait.serde static method)": [[15, "datafusion.substrait.Serde.serialize_to_plan", false]], "session_id() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.session_id", false]], "sessionconfig (class in datafusion)": [[7, "datafusion.SessionConfig", false]], "sessionconfig (class in datafusion.context)": [[2, "datafusion.context.SessionConfig", false]], "sessioncontext (class in datafusion.context)": [[2, "datafusion.context.SessionContext", false]], "set() (datafusion.context.sessionconfig method)": [[2, "datafusion.context.SessionConfig.set", false]], "set() (datafusion.sessionconfig method)": [[7, "datafusion.SessionConfig.set", false]], "set_custom_cell_builder() (datafusion.html_formatter.dataframehtmlformatter method)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter.set_custom_cell_builder", false]], "set_custom_header_builder() (datafusion.html_formatter.dataframehtmlformatter method)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter.set_custom_header_builder", false]], "set_formatter() (datafusion.html_formatter.formattermanager class method)": [[6, "datafusion.html_formatter.FormatterManager.set_formatter", false]], "set_formatter() (in module datafusion.html_formatter)": [[6, "datafusion.html_formatter.set_formatter", false]], "setvariable (in module datafusion.expr)": [[4, "datafusion.expr.SetVariable", false]], "sha224() (datafusion.expr method)": [[7, "datafusion.Expr.sha224", false]], "sha224() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.sha224", false]], "sha224() (in module datafusion.functions)": [[5, "datafusion.functions.sha224", false]], "sha256() (datafusion.expr method)": [[7, "datafusion.Expr.sha256", false]], "sha256() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.sha256", false]], "sha256() (in module datafusion.functions)": [[5, "datafusion.functions.sha256", false]], "sha384() (datafusion.expr method)": [[7, "datafusion.Expr.sha384", false]], "sha384() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.sha384", false]], "sha384() (in module datafusion.functions)": [[5, "datafusion.functions.sha384", false]], "sha512() (datafusion.expr method)": [[7, "datafusion.Expr.sha512", false]], "sha512() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.sha512", false]], "sha512() (in module datafusion.functions)": [[5, "datafusion.functions.sha512", false]], "show() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.show", false]], "show_truncation_message (datafusion.html_formatter.dataframehtmlformatter attribute)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter.show_truncation_message", false]], "signum() (datafusion.expr method)": [[7, "datafusion.Expr.signum", false]], "signum() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.signum", false]], "signum() (in module datafusion.functions)": [[5, "datafusion.functions.signum", false]], "similarto (in module datafusion.expr)": [[4, "datafusion.expr.SimilarTo", false]], "sin() (datafusion.expr method)": [[7, "datafusion.Expr.sin", false]], "sin() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.sin", false]], "sin() (in module datafusion.functions)": [[5, "datafusion.functions.sin", false]], "sinh() (datafusion.expr method)": [[7, "datafusion.Expr.sinh", false]], "sinh() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.sinh", false]], "sinh() (in module datafusion.functions)": [[5, "datafusion.functions.sinh", false]], "snappy (datafusion.dataframe.compression attribute)": [[3, "datafusion.dataframe.Compression.SNAPPY", false]], "sort (in module datafusion.expr)": [[4, "datafusion.expr.Sort", false]], "sort() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.sort", false]], "sort() (datafusion.expr method)": [[7, "datafusion.Expr.sort", false]], "sort() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.sort", false]], "sortexpr (class in datafusion.expr)": [[4, "datafusion.expr.SortExpr", false]], "split_part() (in module datafusion.functions)": [[5, "datafusion.functions.split_part", false]], "sql() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.sql", false]], "sql_with_options() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.sql_with_options", false]], "sqlite() (datafusion.unparser.dialect static method)": [[17, "datafusion.unparser.Dialect.sqlite", false]], "sqloptions (class in datafusion)": [[7, "datafusion.SQLOptions", false]], "sqloptions (class in datafusion.context)": [[2, "datafusion.context.SQLOptions", false]], "sqrt() (datafusion.expr method)": [[7, "datafusion.Expr.sqrt", false]], "sqrt() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.sqrt", false]], "sqrt() (in module datafusion.functions)": [[5, "datafusion.functions.sqrt", false]], "stable (datafusion.user_defined.volatility attribute)": [[18, "datafusion.user_defined.Volatility.Stable", false]], "starts_with() (in module datafusion.functions)": [[5, "datafusion.functions.starts_with", false]], "state() (datafusion.accumulator method)": [[7, "datafusion.Accumulator.state", false]], "state() (datafusion.user_defined.accumulator method)": [[18, "datafusion.user_defined.Accumulator.state", false]], "stddev() (in module datafusion.functions)": [[5, "datafusion.functions.stddev", false]], "stddev_pop() (in module datafusion.functions)": [[5, "datafusion.functions.stddev_pop", false]], "stddev_samp() (in module datafusion.functions)": [[5, "datafusion.functions.stddev_samp", false]], "string_agg() (in module datafusion.functions)": [[5, "datafusion.functions.string_agg", false]], "string_literal() (datafusion.expr static method)": [[7, "datafusion.Expr.string_literal", false]], "string_literal() (datafusion.expr.expr static method)": [[4, "datafusion.expr.Expr.string_literal", false]], "strpos() (in module datafusion.functions)": [[5, "datafusion.functions.strpos", false]], "struct() (in module datafusion.functions)": [[5, "datafusion.functions.struct", false]], "style_provider (datafusion.html_formatter.dataframehtmlformatter attribute)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter.style_provider", false]], "styleprovider (class in datafusion.html_formatter)": [[6, "datafusion.html_formatter.StyleProvider", false]], "subquery (in module datafusion.expr)": [[4, "datafusion.expr.Subquery", false]], "subqueryalias (in module datafusion.expr)": [[4, "datafusion.expr.SubqueryAlias", false]], "substr() (in module datafusion.functions)": [[5, "datafusion.functions.substr", false]], "substr_index() (in module datafusion.functions)": [[5, "datafusion.functions.substr_index", false]], "substring() (in module datafusion.functions)": [[5, "datafusion.functions.substring", false]], "sum() (in module datafusion.functions)": [[5, "datafusion.functions.sum", false]], "supports_bounded_execution() (datafusion.user_defined.windowevaluator method)": [[18, "datafusion.user_defined.WindowEvaluator.supports_bounded_execution", false]], "table (class in datafusion)": [[7, "datafusion.Table", false]], "table (class in datafusion.catalog)": [[0, "datafusion.catalog.Table", false]], "table (datafusion.catalog.table attribute)": [[0, "datafusion.catalog.Table.table", false]], "table (datafusion.table attribute)": [[7, "datafusion.Table.table", false]], "table() (datafusion.catalog.database method)": [[0, "datafusion.catalog.Database.table", false]], "table() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.table", false]], "table() (datafusion.database method)": [[7, "datafusion.Database.table", false]], "table_exist() (datafusion.context.sessioncontext method)": [[2, "datafusion.context.SessionContext.table_exist", false]], "tablefunction (class in datafusion)": [[7, "datafusion.TableFunction", false]], "tablefunction (class in datafusion.user_defined)": [[18, "datafusion.user_defined.TableFunction", false]], "tableproviderexportable (class in datafusion.context)": [[2, "datafusion.context.TableProviderExportable", false]], "tablescan (in module datafusion.expr)": [[4, "datafusion.expr.TableScan", false]], "tail() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.tail", false]], "tan() (datafusion.expr method)": [[7, "datafusion.Expr.tan", false]], "tan() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.tan", false]], "tan() (in module datafusion.functions)": [[5, "datafusion.functions.tan", false]], "tanh() (datafusion.expr method)": [[7, "datafusion.Expr.tanh", false]], "tanh() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.tanh", false]], "tanh() (in module datafusion.functions)": [[5, "datafusion.functions.tanh", false]], "to_arrow_table() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.to_arrow_table", false]], "to_hex() (datafusion.expr method)": [[7, "datafusion.Expr.to_hex", false]], "to_hex() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.to_hex", false]], "to_hex() (in module datafusion.functions)": [[5, "datafusion.functions.to_hex", false]], "to_pandas() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.to_pandas", false]], "to_polars() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.to_polars", false]], "to_proto() (datafusion.executionplan method)": [[7, "datafusion.ExecutionPlan.to_proto", false]], "to_proto() (datafusion.logicalplan method)": [[7, "datafusion.LogicalPlan.to_proto", false]], "to_proto() (datafusion.plan.executionplan method)": [[13, "datafusion.plan.ExecutionPlan.to_proto", false]], "to_proto() (datafusion.plan.logicalplan method)": [[13, "datafusion.plan.LogicalPlan.to_proto", false]], "to_pyarrow() (datafusion.record_batch.recordbatch method)": [[14, "datafusion.record_batch.RecordBatch.to_pyarrow", false]], "to_pyarrow() (datafusion.recordbatch method)": [[7, "datafusion.RecordBatch.to_pyarrow", false]], "to_pydict() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.to_pydict", false]], "to_pylist() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.to_pylist", false]], "to_substrait_plan() (datafusion.substrait.producer static method)": [[15, "datafusion.substrait.Producer.to_substrait_plan", false]], "to_timestamp() (in module datafusion.functions)": [[5, "datafusion.functions.to_timestamp", false]], "to_timestamp_micros() (in module datafusion.functions)": [[5, "datafusion.functions.to_timestamp_micros", false]], "to_timestamp_millis() (in module datafusion.functions)": [[5, "datafusion.functions.to_timestamp_millis", false]], "to_timestamp_nanos() (in module datafusion.functions)": [[5, "datafusion.functions.to_timestamp_nanos", false]], "to_timestamp_seconds() (in module datafusion.functions)": [[5, "datafusion.functions.to_timestamp_seconds", false]], "to_unixtime() (in module datafusion.functions)": [[5, "datafusion.functions.to_unixtime", false]], "to_variant() (datafusion.expr method)": [[7, "datafusion.Expr.to_variant", false]], "to_variant() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.to_variant", false]], "to_variant() (datafusion.logicalplan method)": [[7, "datafusion.LogicalPlan.to_variant", false]], "to_variant() (datafusion.plan.logicalplan method)": [[13, "datafusion.plan.LogicalPlan.to_variant", false]], "transactionaccessmode (in module datafusion.expr)": [[4, "datafusion.expr.TransactionAccessMode", false]], "transactionconclusion (in module datafusion.expr)": [[4, "datafusion.expr.TransactionConclusion", false]], "transactionend (in module datafusion.expr)": [[4, "datafusion.expr.TransactionEnd", false]], "transactionisolationlevel (in module datafusion.expr)": [[4, "datafusion.expr.TransactionIsolationLevel", false]], "transactionstart (in module datafusion.expr)": [[4, "datafusion.expr.TransactionStart", false]], "transform() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.transform", false]], "translate() (in module datafusion.functions)": [[5, "datafusion.functions.translate", false]], "trim() (datafusion.expr method)": [[7, "datafusion.Expr.trim", false]], "trim() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.trim", false]], "trim() (in module datafusion.functions)": [[5, "datafusion.functions.trim", false]], "trunc() (in module datafusion.functions)": [[5, "datafusion.functions.trunc", false]], "trycast (in module datafusion.expr)": [[4, "datafusion.expr.TryCast", false]], "types() (datafusion.expr method)": [[7, "datafusion.Expr.types", false]], "types() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.types", false]], "udaf (in module datafusion)": [[7, "datafusion.udaf", false]], "udaf (in module datafusion.user_defined)": [[18, "datafusion.user_defined.udaf", false]], "udaf() (datafusion.aggregateudf static method)": [[7, "datafusion.AggregateUDF.udaf", false]], "udaf() (datafusion.user_defined.aggregateudf static method)": [[18, "datafusion.user_defined.AggregateUDF.udaf", false]], "udf (in module datafusion)": [[7, "datafusion.udf", false]], "udf (in module datafusion.user_defined)": [[18, "datafusion.user_defined.udf", false]], "udf() (datafusion.scalarudf static method)": [[7, "datafusion.ScalarUDF.udf", false]], "udf() (datafusion.user_defined.scalarudf static method)": [[18, "datafusion.user_defined.ScalarUDF.udf", false]], "udtf (in module datafusion)": [[7, "datafusion.udtf", false]], "udtf (in module datafusion.user_defined)": [[18, "datafusion.user_defined.udtf", false]], "udtf() (datafusion.tablefunction static method)": [[7, "datafusion.TableFunction.udtf", false]], "udtf() (datafusion.user_defined.tablefunction static method)": [[18, "datafusion.user_defined.TableFunction.udtf", false]], "udwf (in module datafusion)": [[7, "datafusion.udwf", false]], "udwf (in module datafusion.user_defined)": [[18, "datafusion.user_defined.udwf", false]], "udwf() (datafusion.user_defined.windowudf static method)": [[18, "datafusion.user_defined.WindowUDF.udwf", false]], "udwf() (datafusion.windowudf static method)": [[7, "datafusion.WindowUDF.udwf", false]], "uncompressed (datafusion.dataframe.compression attribute)": [[3, "datafusion.dataframe.Compression.UNCOMPRESSED", false]], "union (in module datafusion.expr)": [[4, "datafusion.expr.Union", false]], "union() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.union", false]], "union_distinct() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.union_distinct", false]], "unnest (in module datafusion.expr)": [[4, "datafusion.expr.Unnest", false]], "unnest_columns() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.unnest_columns", false]], "unnestexpr (in module datafusion.expr)": [[4, "datafusion.expr.UnnestExpr", false]], "unparser (class in datafusion.unparser)": [[17, "datafusion.unparser.Unparser", false]], "unparser (datafusion.unparser.unparser attribute)": [[17, "datafusion.unparser.Unparser.unparser", false]], "update() (datafusion.accumulator method)": [[7, "datafusion.Accumulator.update", false]], "update() (datafusion.user_defined.accumulator method)": [[18, "datafusion.user_defined.Accumulator.update", false]], "upper() (datafusion.expr method)": [[7, "datafusion.Expr.upper", false]], "upper() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.upper", false]], "upper() (in module datafusion.functions)": [[5, "datafusion.functions.upper", false]], "use_shared_styles (datafusion.html_formatter.dataframehtmlformatter attribute)": [[6, "datafusion.html_formatter.DataFrameHtmlFormatter.use_shared_styles", false]], "uses_window_frame() (datafusion.user_defined.windowevaluator method)": [[18, "datafusion.user_defined.WindowEvaluator.uses_window_frame", false]], "uuid() (in module datafusion.functions)": [[5, "datafusion.functions.uuid", false]], "values (in module datafusion.expr)": [[4, "datafusion.expr.Values", false]], "var() (in module datafusion.functions)": [[5, "datafusion.functions.var", false]], "var_pop() (in module datafusion.functions)": [[5, "datafusion.functions.var_pop", false]], "var_samp() (in module datafusion.functions)": [[5, "datafusion.functions.var_samp", false]], "var_sample() (in module datafusion.functions)": [[5, "datafusion.functions.var_sample", false]], "variant_name() (datafusion.expr method)": [[7, "datafusion.Expr.variant_name", false]], "variant_name() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.variant_name", false]], "volatile (datafusion.user_defined.volatility attribute)": [[18, "datafusion.user_defined.Volatility.Volatile", false]], "volatility (class in datafusion.user_defined)": [[18, "datafusion.user_defined.Volatility", false]], "when() (datafusion.expr.casebuilder method)": [[4, "datafusion.expr.CaseBuilder.when", false]], "when() (in module datafusion.functions)": [[5, "datafusion.functions.when", false]], "window (class in datafusion.expr)": [[4, "datafusion.expr.Window", false]], "window() (in module datafusion.functions)": [[5, "datafusion.functions.window", false]], "window_frame (datafusion.expr.windowframe attribute)": [[4, "datafusion.expr.WindowFrame.window_frame", false]], "window_frame (datafusion.windowframe attribute)": [[7, "datafusion.WindowFrame.window_frame", false]], "window_frame() (datafusion.expr method)": [[7, "datafusion.Expr.window_frame", false]], "window_frame() (datafusion.expr.expr method)": [[4, "datafusion.expr.Expr.window_frame", false]], "windowevaluator (class in datafusion.user_defined)": [[18, "datafusion.user_defined.WindowEvaluator", false]], "windowexpr (in module datafusion.expr)": [[4, "datafusion.expr.WindowExpr", false]], "windowframe (class in datafusion)": [[7, "datafusion.WindowFrame", false]], "windowframe (class in datafusion.expr)": [[4, "datafusion.expr.WindowFrame", false]], "windowframebound (class in datafusion.expr)": [[4, "datafusion.expr.WindowFrameBound", false]], "windowudf (class in datafusion)": [[7, "datafusion.WindowUDF", false]], "windowudf (class in datafusion.user_defined)": [[18, "datafusion.user_defined.WindowUDF", false]], "with_allow_ddl() (datafusion.context.sqloptions method)": [[2, "datafusion.context.SQLOptions.with_allow_ddl", false]], "with_allow_ddl() (datafusion.sqloptions method)": [[7, "datafusion.SQLOptions.with_allow_ddl", false]], "with_allow_dml() (datafusion.context.sqloptions method)": [[2, "datafusion.context.SQLOptions.with_allow_dml", false]], "with_allow_dml() (datafusion.sqloptions method)": [[7, "datafusion.SQLOptions.with_allow_dml", false]], "with_allow_statements() (datafusion.context.sqloptions method)": [[2, "datafusion.context.SQLOptions.with_allow_statements", false]], "with_allow_statements() (datafusion.sqloptions method)": [[7, "datafusion.SQLOptions.with_allow_statements", false]], "with_batch_size() (datafusion.context.sessionconfig method)": [[2, "datafusion.context.SessionConfig.with_batch_size", false]], "with_batch_size() (datafusion.sessionconfig method)": [[7, "datafusion.SessionConfig.with_batch_size", false]], "with_column() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.with_column", false]], "with_column_renamed() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.with_column_renamed", false]], "with_columns() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.with_columns", false]], "with_create_default_catalog_and_schema() (datafusion.context.sessionconfig method)": [[2, "datafusion.context.SessionConfig.with_create_default_catalog_and_schema", false]], "with_create_default_catalog_and_schema() (datafusion.sessionconfig method)": [[7, "datafusion.SessionConfig.with_create_default_catalog_and_schema", false]], "with_default_catalog_and_schema() (datafusion.context.sessionconfig method)": [[2, "datafusion.context.SessionConfig.with_default_catalog_and_schema", false]], "with_default_catalog_and_schema() (datafusion.sessionconfig method)": [[7, "datafusion.SessionConfig.with_default_catalog_and_schema", false]], "with_disk_manager_disabled() (datafusion.context.runtimeenvbuilder method)": [[2, "datafusion.context.RuntimeEnvBuilder.with_disk_manager_disabled", false]], "with_disk_manager_disabled() (datafusion.runtimeenvbuilder method)": [[7, "datafusion.RuntimeEnvBuilder.with_disk_manager_disabled", false]], "with_disk_manager_os() (datafusion.context.runtimeenvbuilder method)": [[2, "datafusion.context.RuntimeEnvBuilder.with_disk_manager_os", false]], "with_disk_manager_os() (datafusion.runtimeenvbuilder method)": [[7, "datafusion.RuntimeEnvBuilder.with_disk_manager_os", false]], "with_disk_manager_specified() (datafusion.context.runtimeenvbuilder method)": [[2, "datafusion.context.RuntimeEnvBuilder.with_disk_manager_specified", false]], "with_disk_manager_specified() (datafusion.runtimeenvbuilder method)": [[7, "datafusion.RuntimeEnvBuilder.with_disk_manager_specified", false]], "with_fair_spill_pool() (datafusion.context.runtimeenvbuilder method)": [[2, "datafusion.context.RuntimeEnvBuilder.with_fair_spill_pool", false]], "with_fair_spill_pool() (datafusion.runtimeenvbuilder method)": [[7, "datafusion.RuntimeEnvBuilder.with_fair_spill_pool", false]], "with_greedy_memory_pool() (datafusion.context.runtimeenvbuilder method)": [[2, "datafusion.context.RuntimeEnvBuilder.with_greedy_memory_pool", false]], "with_greedy_memory_pool() (datafusion.runtimeenvbuilder method)": [[7, "datafusion.RuntimeEnvBuilder.with_greedy_memory_pool", false]], "with_information_schema() (datafusion.context.sessionconfig method)": [[2, "datafusion.context.SessionConfig.with_information_schema", false]], "with_information_schema() (datafusion.sessionconfig method)": [[7, "datafusion.SessionConfig.with_information_schema", false]], "with_parquet_pruning() (datafusion.context.sessionconfig method)": [[2, "datafusion.context.SessionConfig.with_parquet_pruning", false]], "with_parquet_pruning() (datafusion.sessionconfig method)": [[7, "datafusion.SessionConfig.with_parquet_pruning", false]], "with_pretty() (datafusion.unparser.unparser method)": [[17, "datafusion.unparser.Unparser.with_pretty", false]], "with_repartition_aggregations() (datafusion.context.sessionconfig method)": [[2, "datafusion.context.SessionConfig.with_repartition_aggregations", false]], "with_repartition_aggregations() (datafusion.sessionconfig method)": [[7, "datafusion.SessionConfig.with_repartition_aggregations", false]], "with_repartition_file_min_size() (datafusion.context.sessionconfig method)": [[2, "datafusion.context.SessionConfig.with_repartition_file_min_size", false]], "with_repartition_file_min_size() (datafusion.sessionconfig method)": [[7, "datafusion.SessionConfig.with_repartition_file_min_size", false]], "with_repartition_file_scans() (datafusion.context.sessionconfig method)": [[2, "datafusion.context.SessionConfig.with_repartition_file_scans", false]], "with_repartition_file_scans() (datafusion.sessionconfig method)": [[7, "datafusion.SessionConfig.with_repartition_file_scans", false]], "with_repartition_joins() (datafusion.context.sessionconfig method)": [[2, "datafusion.context.SessionConfig.with_repartition_joins", false]], "with_repartition_joins() (datafusion.sessionconfig method)": [[7, "datafusion.SessionConfig.with_repartition_joins", false]], "with_repartition_sorts() (datafusion.context.sessionconfig method)": [[2, "datafusion.context.SessionConfig.with_repartition_sorts", false]], "with_repartition_sorts() (datafusion.sessionconfig method)": [[7, "datafusion.SessionConfig.with_repartition_sorts", false]], "with_repartition_windows() (datafusion.context.sessionconfig method)": [[2, "datafusion.context.SessionConfig.with_repartition_windows", false]], "with_repartition_windows() (datafusion.sessionconfig method)": [[7, "datafusion.SessionConfig.with_repartition_windows", false]], "with_target_partitions() (datafusion.context.sessionconfig method)": [[2, "datafusion.context.SessionConfig.with_target_partitions", false]], "with_target_partitions() (datafusion.sessionconfig method)": [[7, "datafusion.SessionConfig.with_target_partitions", false]], "with_temp_file_path() (datafusion.context.runtimeenvbuilder method)": [[2, "datafusion.context.RuntimeEnvBuilder.with_temp_file_path", false]], "with_temp_file_path() (datafusion.runtimeenvbuilder method)": [[7, "datafusion.RuntimeEnvBuilder.with_temp_file_path", false]], "with_unbounded_memory_pool() (datafusion.context.runtimeenvbuilder method)": [[2, "datafusion.context.RuntimeEnvBuilder.with_unbounded_memory_pool", false]], "with_unbounded_memory_pool() (datafusion.runtimeenvbuilder method)": [[7, "datafusion.RuntimeEnvBuilder.with_unbounded_memory_pool", false]], "write_csv() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.write_csv", false]], "write_json() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.write_json", false]], "write_parquet() (datafusion.dataframe.dataframe method)": [[3, "datafusion.dataframe.DataFrame.write_parquet", false]], "zstd (datafusion.dataframe.compression attribute)": [[3, "datafusion.dataframe.Compression.ZSTD", false]]}, "objects": {"": [[7, 0, 0, "-", "datafusion"]], "datafusion": [[7, 1, 1, "", "Accumulator"], [7, 1, 1, "", "AggregateUDF"], [7, 1, 1, "", "Catalog"], [7, 4, 1, "", "DFSchema"], [7, 1, 1, "", "Database"], [7, 1, 1, "", "ExecutionPlan"], [7, 1, 1, "", "Expr"], [7, 1, 1, "", "LogicalPlan"], [7, 1, 1, "", "RecordBatch"], [7, 1, 1, "", "RecordBatchStream"], [7, 1, 1, "", "RuntimeEnvBuilder"], [7, 1, 1, "", "SQLOptions"], [7, 1, 1, "", "ScalarUDF"], [7, 1, 1, "", "SessionConfig"], [7, 1, 1, "", "Table"], [7, 1, 1, "", "TableFunction"], [7, 1, 1, "", "WindowFrame"], [7, 1, 1, "", "WindowUDF"], [0, 0, 0, "-", "catalog"], [7, 4, 1, "", "col"], [1, 0, 0, "-", "col"], [7, 4, 1, "", "column"], [7, 6, 1, "", "configure_formatter"], [2, 0, 0, "-", "context"], [3, 0, 0, "-", "dataframe"], [4, 0, 0, "-", "expr"], [5, 0, 0, "-", "functions"], [6, 0, 0, "-", "html_formatter"], [9, 0, 0, "-", "input"], [11, 0, 0, "-", "io"], [7, 6, 1, "", "lit"], [7, 6, 1, "", "literal"], [12, 0, 0, "-", "object_store"], [13, 0, 0, "-", "plan"], [7, 6, 1, "", "read_avro"], [7, 6, 1, "", "read_csv"], [7, 6, 1, "", "read_json"], [7, 6, 1, "", "read_parquet"], [14, 0, 0, "-", "record_batch"], [15, 0, 0, "-", "substrait"], [7, 4, 1, "", "udaf"], [16, 0, 0, "-", "udf"], [7, 4, 1, "", "udtf"], [7, 4, 1, "", "udwf"], [17, 0, 0, "-", "unparser"], [18, 0, 0, "-", "user_defined"]], "datafusion.Accumulator": [[7, 2, 1, "", "evaluate"], [7, 2, 1, "", "merge"], [7, 2, 1, "", "state"], [7, 2, 1, "", "update"]], "datafusion.AggregateUDF": [[7, 2, 1, "", "__call__"], [7, 3, 1, "", "_udaf"], [7, 2, 1, "", "udaf"]], "datafusion.Catalog": [[7, 3, 1, "", "catalog"], [7, 2, 1, "", "database"], [7, 2, 1, "", "names"]], "datafusion.Database": [[7, 3, 1, "", "db"], [7, 2, 1, "", "names"], [7, 2, 1, "", "table"]], "datafusion.ExecutionPlan": [[7, 2, 1, "", "__repr__"], [7, 3, 1, "", "_raw_plan"], [7, 2, 1, "", "children"], [7, 2, 1, "", "display"], [7, 2, 1, "", "display_indent"], [7, 2, 1, "", "from_proto"], [7, 5, 1, "", "partition_count"], [7, 2, 1, "", "to_proto"]], "datafusion.Expr": [[7, 2, 1, "", "__add__"], [7, 2, 1, "", "__and__"], [7, 2, 1, "", "__eq__"], [7, 2, 1, "", "__ge__"], [7, 2, 1, "", "__getitem__"], [7, 2, 1, "", "__gt__"], [7, 2, 1, "", "__invert__"], [7, 2, 1, "", "__le__"], [7, 2, 1, "", "__lt__"], [7, 2, 1, "", "__mod__"], [7, 2, 1, "", "__mul__"], [7, 2, 1, "", "__ne__"], [7, 2, 1, "", "__or__"], [7, 3, 1, "", "__radd__"], [7, 3, 1, "", "__rand__"], [7, 2, 1, "", "__repr__"], [7, 2, 1, "", "__richcmp__"], [7, 3, 1, "", "__rmod__"], [7, 3, 1, "", "__rmul__"], [7, 3, 1, "", "__ror__"], [7, 3, 1, "", "__rsub__"], [7, 3, 1, "", "__rtruediv__"], [7, 2, 1, "", "__sub__"], [7, 2, 1, "", "__truediv__"], [7, 3, 1, "", "_to_pyarrow_types"], [7, 2, 1, "", "abs"], [7, 2, 1, "", "acos"], [7, 2, 1, "", "acosh"], [7, 2, 1, "", "alias"], [7, 2, 1, "", "array_dims"], [7, 2, 1, "", "array_distinct"], [7, 2, 1, "", "array_empty"], [7, 2, 1, "", "array_length"], [7, 2, 1, "", "array_ndims"], [7, 2, 1, "", "array_pop_back"], [7, 2, 1, "", "array_pop_front"], [7, 2, 1, "", "arrow_typeof"], [7, 2, 1, "", "ascii"], [7, 2, 1, "", "asin"], [7, 2, 1, "", "asinh"], [7, 2, 1, "", "atan"], [7, 2, 1, "", "atanh"], [7, 2, 1, "", "between"], [7, 2, 1, "", "bit_length"], [7, 2, 1, "", "btrim"], [7, 2, 1, "", "canonical_name"], [7, 2, 1, "", "cardinality"], [7, 2, 1, "", "cast"], [7, 2, 1, "", "cbrt"], [7, 2, 1, "", "ceil"], [7, 2, 1, "", "char_length"], [7, 2, 1, "", "character_length"], [7, 2, 1, "", "chr"], [7, 2, 1, "", "column"], [7, 2, 1, "", "column_name"], [7, 2, 1, "", "cos"], [7, 2, 1, "", "cosh"], [7, 2, 1, "", "cot"], [7, 2, 1, "", "degrees"], [7, 2, 1, "", "display_name"], [7, 2, 1, "", "distinct"], [7, 2, 1, "", "empty"], [7, 2, 1, "", "exp"], [7, 3, 1, "", "expr"], [7, 2, 1, "", "factorial"], [7, 2, 1, "", "fill_nan"], [7, 2, 1, "", "fill_null"], [7, 2, 1, "", "filter"], [7, 2, 1, "", "flatten"], [7, 2, 1, "", "floor"], [7, 2, 1, "", "from_unixtime"], [7, 2, 1, "", "initcap"], [7, 2, 1, "", "is_not_null"], [7, 2, 1, "", "is_null"], [7, 2, 1, "", "isnan"], [7, 2, 1, "", "iszero"], [7, 2, 1, "", "length"], [7, 2, 1, "", "list_dims"], [7, 2, 1, "", "list_distinct"], [7, 2, 1, "", "list_length"], [7, 2, 1, "", "list_ndims"], [7, 2, 1, "", "literal"], [7, 2, 1, "", "ln"], [7, 2, 1, "", "log10"], [7, 2, 1, "", "log2"], [7, 2, 1, "", "lower"], [7, 2, 1, "", "ltrim"], [7, 2, 1, "", "md5"], [7, 2, 1, "", "null_treatment"], [7, 2, 1, "", "octet_length"], [7, 2, 1, "", "order_by"], [7, 2, 1, "", "over"], [7, 2, 1, "", "partition_by"], [7, 2, 1, "", "python_value"], [7, 2, 1, "", "radians"], [7, 2, 1, "", "reverse"], [7, 2, 1, "", "rex_call_operands"], [7, 2, 1, "", "rex_call_operator"], [7, 2, 1, "", "rex_type"], [7, 2, 1, "", "rtrim"], [7, 2, 1, "", "schema_name"], [7, 2, 1, "", "sha224"], [7, 2, 1, "", "sha256"], [7, 2, 1, "", "sha384"], [7, 2, 1, "", "sha512"], [7, 2, 1, "", "signum"], [7, 2, 1, "", "sin"], [7, 2, 1, "", "sinh"], [7, 2, 1, "", "sort"], [7, 2, 1, "", "sqrt"], [7, 2, 1, "", "string_literal"], [7, 2, 1, "", "tan"], [7, 2, 1, "", "tanh"], [7, 2, 1, "", "to_hex"], [7, 2, 1, "", "to_variant"], [7, 2, 1, "", "trim"], [7, 2, 1, "", "types"], [7, 2, 1, "", "upper"], [7, 2, 1, "", "variant_name"], [7, 2, 1, "", "window_frame"]], "datafusion.LogicalPlan": [[7, 2, 1, "", "__repr__"], [7, 3, 1, "", "_raw_plan"], [7, 2, 1, "", "display"], [7, 2, 1, "", "display_graphviz"], [7, 2, 1, "", "display_indent"], [7, 2, 1, "", "display_indent_schema"], [7, 2, 1, "", "from_proto"], [7, 2, 1, "", "inputs"], [7, 2, 1, "", "to_proto"], [7, 2, 1, "", "to_variant"]], "datafusion.RecordBatch": [[7, 3, 1, "", "record_batch"], [7, 2, 1, "", "to_pyarrow"]], "datafusion.RecordBatchStream": [[7, 2, 1, "", "__aiter__"], [7, 2, 1, "", "__anext__"], [7, 2, 1, "", "__iter__"], [7, 2, 1, "", "__next__"], [7, 2, 1, "", "next"], [7, 3, 1, "", "rbs"]], "datafusion.RuntimeEnvBuilder": [[7, 3, 1, "", "config_internal"], [7, 2, 1, "", "with_disk_manager_disabled"], [7, 2, 1, "", "with_disk_manager_os"], [7, 2, 1, "", "with_disk_manager_specified"], [7, 2, 1, "", "with_fair_spill_pool"], [7, 2, 1, "", "with_greedy_memory_pool"], [7, 2, 1, "", "with_temp_file_path"], [7, 2, 1, "", "with_unbounded_memory_pool"]], "datafusion.SQLOptions": [[7, 3, 1, "", "options_internal"], [7, 2, 1, "", "with_allow_ddl"], [7, 2, 1, "", "with_allow_dml"], [7, 2, 1, "", "with_allow_statements"]], "datafusion.ScalarUDF": [[7, 2, 1, "", "__call__"], [7, 3, 1, "", "_udf"], [7, 2, 1, "", "udf"]], "datafusion.SessionConfig": [[7, 3, 1, "", "config_internal"], [7, 2, 1, "", "set"], [7, 2, 1, "", "with_batch_size"], [7, 2, 1, "", "with_create_default_catalog_and_schema"], [7, 2, 1, "", "with_default_catalog_and_schema"], [7, 2, 1, "", "with_information_schema"], [7, 2, 1, "", "with_parquet_pruning"], [7, 2, 1, "", "with_repartition_aggregations"], [7, 2, 1, "", "with_repartition_file_min_size"], [7, 2, 1, "", "with_repartition_file_scans"], [7, 2, 1, "", "with_repartition_joins"], [7, 2, 1, "", "with_repartition_sorts"], [7, 2, 1, "", "with_repartition_windows"], [7, 2, 1, "", "with_target_partitions"]], "datafusion.Table": [[7, 5, 1, "", "kind"], [7, 5, 1, "", "schema"], [7, 3, 1, "", "table"]], "datafusion.TableFunction": [[7, 2, 1, "", "__call__"], [7, 2, 1, "", "__repr__"], [7, 2, 1, "", "_create_table_udf"], [7, 2, 1, "", "_create_table_udf_decorator"], [7, 3, 1, "", "_udtf"], [7, 2, 1, "", "udtf"]], "datafusion.WindowFrame": [[7, 2, 1, "", "get_frame_units"], [7, 2, 1, "", "get_lower_bound"], [7, 2, 1, "", "get_upper_bound"], [7, 3, 1, "", "window_frame"]], "datafusion.WindowUDF": [[7, 2, 1, "", "__call__"], [7, 2, 1, "", "_create_window_udf"], [7, 2, 1, "", "_create_window_udf_decorator"], [7, 2, 1, "", "_get_default_name"], [7, 2, 1, "", "_normalize_input_types"], [7, 3, 1, "", "_udwf"], [7, 2, 1, "", "udwf"]], "datafusion.catalog": [[0, 1, 1, "", "Catalog"], [0, 1, 1, "", "Database"], [0, 1, 1, "", "Table"]], "datafusion.catalog.Catalog": [[0, 3, 1, "", "catalog"], [0, 2, 1, "", "database"], [0, 2, 1, "", "names"]], "datafusion.catalog.Database": [[0, 3, 1, "", "db"], [0, 2, 1, "", "names"], [0, 2, 1, "", "table"]], "datafusion.catalog.Table": [[0, 5, 1, "", "kind"], [0, 5, 1, "", "schema"], [0, 3, 1, "", "table"]], "datafusion.col": [[1, 4, 1, "", "col"], [1, 4, 1, "", "column"]], "datafusion.context": [[2, 1, 1, "", "ArrowArrayExportable"], [2, 1, 1, "", "ArrowStreamExportable"], [2, 1, 1, "", "RuntimeConfig"], [2, 1, 1, "", "RuntimeEnvBuilder"], [2, 1, 1, "", "SQLOptions"], [2, 1, 1, "", "SessionConfig"], [2, 1, 1, "", "SessionContext"], [2, 1, 1, "", "TableProviderExportable"]], "datafusion.context.ArrowArrayExportable": [[2, 2, 1, "", "__arrow_c_array__"]], "datafusion.context.ArrowStreamExportable": [[2, 2, 1, "", "__arrow_c_stream__"]], "datafusion.context.RuntimeEnvBuilder": [[2, 3, 1, "", "config_internal"], [2, 2, 1, "", "with_disk_manager_disabled"], [2, 2, 1, "", "with_disk_manager_os"], [2, 2, 1, "", "with_disk_manager_specified"], [2, 2, 1, "", "with_fair_spill_pool"], [2, 2, 1, "", "with_greedy_memory_pool"], [2, 2, 1, "", "with_temp_file_path"], [2, 2, 1, "", "with_unbounded_memory_pool"]], "datafusion.context.SQLOptions": [[2, 3, 1, "", "options_internal"], [2, 2, 1, "", "with_allow_ddl"], [2, 2, 1, "", "with_allow_dml"], [2, 2, 1, "", "with_allow_statements"]], "datafusion.context.SessionConfig": [[2, 3, 1, "", "config_internal"], [2, 2, 1, "", "set"], [2, 2, 1, "", "with_batch_size"], [2, 2, 1, "", "with_create_default_catalog_and_schema"], [2, 2, 1, "", "with_default_catalog_and_schema"], [2, 2, 1, "", "with_information_schema"], [2, 2, 1, "", "with_parquet_pruning"], [2, 2, 1, "", "with_repartition_aggregations"], [2, 2, 1, "", "with_repartition_file_min_size"], [2, 2, 1, "", "with_repartition_file_scans"], [2, 2, 1, "", "with_repartition_joins"], [2, 2, 1, "", "with_repartition_sorts"], [2, 2, 1, "", "with_repartition_windows"], [2, 2, 1, "", "with_target_partitions"]], "datafusion.context.SessionContext": [[2, 2, 1, "", "catalog"], [2, 2, 1, "", "create_dataframe"], [2, 2, 1, "", "create_dataframe_from_logical_plan"], [2, 3, 1, "", "ctx"], [2, 2, 1, "", "deregister_table"], [2, 2, 1, "", "empty_table"], [2, 2, 1, "", "enable_url_table"], [2, 2, 1, "", "execute"], [2, 2, 1, "", "from_arrow"], [2, 2, 1, "", "from_arrow_table"], [2, 2, 1, "", "from_pandas"], [2, 2, 1, "", "from_polars"], [2, 2, 1, "", "from_pydict"], [2, 2, 1, "", "from_pylist"], [2, 2, 1, "", "global_ctx"], [2, 2, 1, "", "read_avro"], [2, 2, 1, "", "read_csv"], [2, 2, 1, "", "read_json"], [2, 2, 1, "", "read_parquet"], [2, 2, 1, "", "read_table"], [2, 2, 1, "", "register_avro"], [2, 2, 1, "", "register_csv"], [2, 2, 1, "", "register_dataset"], [2, 2, 1, "", "register_json"], [2, 2, 1, "", "register_listing_table"], [2, 2, 1, "", "register_object_store"], [2, 2, 1, "", "register_parquet"], [2, 2, 1, "", "register_record_batches"], [2, 2, 1, "", "register_table"], [2, 2, 1, "", "register_table_provider"], [2, 2, 1, "", "register_udaf"], [2, 2, 1, "", "register_udf"], [2, 2, 1, "", "register_udtf"], [2, 2, 1, "", "register_udwf"], [2, 2, 1, "", "register_view"], [2, 2, 1, "", "session_id"], [2, 2, 1, "", "sql"], [2, 2, 1, "", "sql_with_options"], [2, 2, 1, "", "table"], [2, 2, 1, "", "table_exist"]], "datafusion.context.TableProviderExportable": [[2, 2, 1, "", "__datafusion_table_provider__"]], "datafusion.dataframe": [[3, 1, 1, "", "Compression"], [3, 1, 1, "", "DataFrame"]], "datafusion.dataframe.Compression": [[3, 3, 1, "", "BROTLI"], [3, 3, 1, "", "GZIP"], [3, 3, 1, "", "LZ4"], [3, 3, 1, "", "LZ4_RAW"], [3, 3, 1, "", "SNAPPY"], [3, 3, 1, "", "UNCOMPRESSED"], [3, 3, 1, "", "ZSTD"], [3, 2, 1, "", "from_str"], [3, 2, 1, "", "get_default_level"]], "datafusion.dataframe.DataFrame": [[3, 2, 1, "", "__arrow_c_stream__"], [3, 2, 1, "", "__getitem__"], [3, 2, 1, "", "__repr__"], [3, 2, 1, "", "_repr_html_"], [3, 2, 1, "", "aggregate"], [3, 2, 1, "", "cache"], [3, 2, 1, "", "cast"], [3, 2, 1, "", "collect"], [3, 2, 1, "", "collect_partitioned"], [3, 2, 1, "", "count"], [3, 2, 1, "", "describe"], [3, 3, 1, "", "df"], [3, 2, 1, "", "distinct"], [3, 2, 1, "", "drop"], [3, 2, 1, "", "except_all"], [3, 2, 1, "", "execute_stream"], [3, 2, 1, "", "execute_stream_partitioned"], [3, 2, 1, "", "execution_plan"], [3, 2, 1, "", "explain"], [3, 2, 1, "", "fill_null"], [3, 2, 1, "", "filter"], [3, 2, 1, "", "head"], [3, 2, 1, "", "intersect"], [3, 2, 1, "", "into_view"], [3, 2, 1, "", "join"], [3, 2, 1, "", "join_on"], [3, 2, 1, "", "limit"], [3, 2, 1, "", "logical_plan"], [3, 2, 1, "", "optimized_logical_plan"], [3, 2, 1, "", "repartition"], [3, 2, 1, "", "repartition_by_hash"], [3, 2, 1, "", "schema"], [3, 2, 1, "", "select"], [3, 2, 1, "", "select_columns"], [3, 2, 1, "", "show"], [3, 2, 1, "", "sort"], [3, 2, 1, "", "tail"], [3, 2, 1, "", "to_arrow_table"], [3, 2, 1, "", "to_pandas"], [3, 2, 1, "", "to_polars"], [3, 2, 1, "", "to_pydict"], [3, 2, 1, "", "to_pylist"], [3, 2, 1, "", "transform"], [3, 2, 1, "", "union"], [3, 2, 1, "", "union_distinct"], [3, 2, 1, "", "unnest_columns"], [3, 2, 1, "", "with_column"], [3, 2, 1, "", "with_column_renamed"], [3, 2, 1, "", "with_columns"], [3, 2, 1, "", "write_csv"], [3, 2, 1, "", "write_json"], [3, 2, 1, "", "write_parquet"]], "datafusion.expr": [[4, 4, 1, "", "Aggregate"], [4, 4, 1, "", "AggregateFunction"], [4, 4, 1, "", "Alias"], [4, 4, 1, "", "Analyze"], [4, 4, 1, "", "Between"], [4, 4, 1, "", "BinaryExpr"], [4, 4, 1, "", "Case"], [4, 1, 1, "", "CaseBuilder"], [4, 4, 1, "", "Cast"], [4, 4, 1, "", "Column"], [4, 4, 1, "", "CopyTo"], [4, 4, 1, "", "CreateCatalog"], [4, 4, 1, "", "CreateCatalogSchema"], [4, 4, 1, "", "CreateExternalTable"], [4, 4, 1, "", "CreateFunction"], [4, 4, 1, "", "CreateFunctionBody"], [4, 4, 1, "", "CreateIndex"], [4, 4, 1, "", "CreateMemoryTable"], [4, 4, 1, "", "CreateView"], [4, 4, 1, "", "Deallocate"], [4, 4, 1, "", "DescribeTable"], [4, 4, 1, "", "Distinct"], [4, 4, 1, "", "DmlStatement"], [4, 4, 1, "", "DropCatalogSchema"], [4, 4, 1, "", "DropFunction"], [4, 4, 1, "", "DropTable"], [4, 4, 1, "", "DropView"], [4, 4, 1, "", "EmptyRelation"], [4, 4, 1, "", "Execute"], [4, 4, 1, "", "Exists"], [4, 4, 1, "", "Explain"], [4, 1, 1, "", "Expr"], [4, 4, 1, "", "Extension"], [4, 4, 1, "", "FileType"], [4, 4, 1, "", "Filter"], [4, 4, 1, "", "GroupingSet"], [4, 4, 1, "", "ILike"], [4, 4, 1, "", "InList"], [4, 4, 1, "", "InSubquery"], [4, 4, 1, "", "IsFalse"], [4, 4, 1, "", "IsNotFalse"], [4, 4, 1, "", "IsNotNull"], [4, 4, 1, "", "IsNotTrue"], [4, 4, 1, "", "IsNotUnknown"], [4, 4, 1, "", "IsNull"], [4, 4, 1, "", "IsTrue"], [4, 4, 1, "", "IsUnknown"], [4, 4, 1, "", "Join"], [4, 4, 1, "", "JoinConstraint"], [4, 4, 1, "", "JoinType"], [4, 4, 1, "", "Like"], [4, 4, 1, "", "Limit"], [4, 4, 1, "", "Literal"], [4, 4, 1, "", "Negative"], [4, 4, 1, "", "Not"], [4, 4, 1, "", "OperateFunctionArg"], [4, 4, 1, "", "Partitioning"], [4, 4, 1, "", "Placeholder"], [4, 4, 1, "", "Prepare"], [4, 4, 1, "", "Projection"], [4, 4, 1, "", "RecursiveQuery"], [4, 4, 1, "", "Repartition"], [4, 4, 1, "", "ScalarSubquery"], [4, 4, 1, "", "ScalarVariable"], [4, 4, 1, "", "SetVariable"], [4, 4, 1, "", "SimilarTo"], [4, 4, 1, "", "Sort"], [4, 1, 1, "", "SortExpr"], [4, 4, 1, "", "Subquery"], [4, 4, 1, "", "SubqueryAlias"], [4, 4, 1, "", "TableScan"], [4, 4, 1, "", "TransactionAccessMode"], [4, 4, 1, "", "TransactionConclusion"], [4, 4, 1, "", "TransactionEnd"], [4, 4, 1, "", "TransactionIsolationLevel"], [4, 4, 1, "", "TransactionStart"], [4, 4, 1, "", "TryCast"], [4, 4, 1, "", "Union"], [4, 4, 1, "", "Unnest"], [4, 4, 1, "", "UnnestExpr"], [4, 4, 1, "", "Values"], [4, 1, 1, "", "Window"], [4, 4, 1, "", "WindowExpr"], [4, 1, 1, "", "WindowFrame"], [4, 1, 1, "", "WindowFrameBound"]], "datafusion.expr.CaseBuilder": [[4, 3, 1, "", "case_builder"], [4, 2, 1, "", "end"], [4, 2, 1, "", "otherwise"], [4, 2, 1, "", "when"]], "datafusion.expr.Expr": [[4, 2, 1, "", "__add__"], [4, 2, 1, "", "__and__"], [4, 2, 1, "", "__eq__"], [4, 2, 1, "", "__ge__"], [4, 2, 1, "", "__getitem__"], [4, 2, 1, "", "__gt__"], [4, 2, 1, "", "__invert__"], [4, 2, 1, "", "__le__"], [4, 2, 1, "", "__lt__"], [4, 2, 1, "", "__mod__"], [4, 2, 1, "", "__mul__"], [4, 2, 1, "", "__ne__"], [4, 2, 1, "", "__or__"], [4, 3, 1, "", "__radd__"], [4, 3, 1, "", "__rand__"], [4, 2, 1, "", "__repr__"], [4, 2, 1, "", "__richcmp__"], [4, 3, 1, "", "__rmod__"], [4, 3, 1, "", "__rmul__"], [4, 3, 1, "", "__ror__"], [4, 3, 1, "", "__rsub__"], [4, 3, 1, "", "__rtruediv__"], [4, 2, 1, "", "__sub__"], [4, 2, 1, "", "__truediv__"], [4, 3, 1, "", "_to_pyarrow_types"], [4, 2, 1, "", "abs"], [4, 2, 1, "", "acos"], [4, 2, 1, "", "acosh"], [4, 2, 1, "", "alias"], [4, 2, 1, "", "array_dims"], [4, 2, 1, "", "array_distinct"], [4, 2, 1, "", "array_empty"], [4, 2, 1, "", "array_length"], [4, 2, 1, "", "array_ndims"], [4, 2, 1, "", "array_pop_back"], [4, 2, 1, "", "array_pop_front"], [4, 2, 1, "", "arrow_typeof"], [4, 2, 1, "", "ascii"], [4, 2, 1, "", "asin"], [4, 2, 1, "", "asinh"], [4, 2, 1, "", "atan"], [4, 2, 1, "", "atanh"], [4, 2, 1, "", "between"], [4, 2, 1, "", "bit_length"], [4, 2, 1, "", "btrim"], [4, 2, 1, "", "canonical_name"], [4, 2, 1, "", "cardinality"], [4, 2, 1, "", "cast"], [4, 2, 1, "", "cbrt"], [4, 2, 1, "", "ceil"], [4, 2, 1, "", "char_length"], [4, 2, 1, "", "character_length"], [4, 2, 1, "", "chr"], [4, 2, 1, "", "column"], [4, 2, 1, "", "column_name"], [4, 2, 1, "", "cos"], [4, 2, 1, "", "cosh"], [4, 2, 1, "", "cot"], [4, 2, 1, "", "degrees"], [4, 2, 1, "", "display_name"], [4, 2, 1, "", "distinct"], [4, 2, 1, "", "empty"], [4, 2, 1, "", "exp"], [4, 3, 1, "", "expr"], [4, 2, 1, "", "factorial"], [4, 2, 1, "", "fill_nan"], [4, 2, 1, "", "fill_null"], [4, 2, 1, "", "filter"], [4, 2, 1, "", "flatten"], [4, 2, 1, "", "floor"], [4, 2, 1, "", "from_unixtime"], [4, 2, 1, "", "initcap"], [4, 2, 1, "", "is_not_null"], [4, 2, 1, "", "is_null"], [4, 2, 1, "", "isnan"], [4, 2, 1, "", "iszero"], [4, 2, 1, "", "length"], [4, 2, 1, "", "list_dims"], [4, 2, 1, "", "list_distinct"], [4, 2, 1, "", "list_length"], [4, 2, 1, "", "list_ndims"], [4, 2, 1, "", "literal"], [4, 2, 1, "", "ln"], [4, 2, 1, "", "log10"], [4, 2, 1, "", "log2"], [4, 2, 1, "", "lower"], [4, 2, 1, "", "ltrim"], [4, 2, 1, "", "md5"], [4, 2, 1, "", "null_treatment"], [4, 2, 1, "", "octet_length"], [4, 2, 1, "", "order_by"], [4, 2, 1, "", "over"], [4, 2, 1, "", "partition_by"], [4, 2, 1, "", "python_value"], [4, 2, 1, "", "radians"], [4, 2, 1, "", "reverse"], [4, 2, 1, "", "rex_call_operands"], [4, 2, 1, "", "rex_call_operator"], [4, 2, 1, "", "rex_type"], [4, 2, 1, "", "rtrim"], [4, 2, 1, "", "schema_name"], [4, 2, 1, "", "sha224"], [4, 2, 1, "", "sha256"], [4, 2, 1, "", "sha384"], [4, 2, 1, "", "sha512"], [4, 2, 1, "", "signum"], [4, 2, 1, "", "sin"], [4, 2, 1, "", "sinh"], [4, 2, 1, "", "sort"], [4, 2, 1, "", "sqrt"], [4, 2, 1, "", "string_literal"], [4, 2, 1, "", "tan"], [4, 2, 1, "", "tanh"], [4, 2, 1, "", "to_hex"], [4, 2, 1, "", "to_variant"], [4, 2, 1, "", "trim"], [4, 2, 1, "", "types"], [4, 2, 1, "", "upper"], [4, 2, 1, "", "variant_name"], [4, 2, 1, "", "window_frame"]], "datafusion.expr.SortExpr": [[4, 2, 1, "", "__repr__"], [4, 2, 1, "", "ascending"], [4, 2, 1, "", "expr"], [4, 2, 1, "", "nulls_first"], [4, 3, 1, "", "raw_sort"]], "datafusion.expr.Window": [[4, 3, 1, "", "_null_treatment"], [4, 3, 1, "", "_order_by"], [4, 3, 1, "", "_partition_by"], [4, 3, 1, "", "_window_frame"]], "datafusion.expr.WindowFrame": [[4, 2, 1, "", "get_frame_units"], [4, 2, 1, "", "get_lower_bound"], [4, 2, 1, "", "get_upper_bound"], [4, 3, 1, "", "window_frame"]], "datafusion.expr.WindowFrameBound": [[4, 3, 1, "", "frame_bound"], [4, 2, 1, "", "get_offset"], [4, 2, 1, "", "is_current_row"], [4, 2, 1, "", "is_following"], [4, 2, 1, "", "is_preceding"], [4, 2, 1, "", "is_unbounded"]], "datafusion.functions": [[5, 6, 1, "", "abs"], [5, 6, 1, "", "acos"], [5, 6, 1, "", "acosh"], [5, 6, 1, "", "alias"], [5, 6, 1, "", "approx_distinct"], [5, 6, 1, "", "approx_median"], [5, 6, 1, "", "approx_percentile_cont"], [5, 6, 1, "", "approx_percentile_cont_with_weight"], [5, 6, 1, "", "array"], [5, 6, 1, "", "array_agg"], [5, 6, 1, "", "array_append"], [5, 6, 1, "", "array_cat"], [5, 6, 1, "", "array_concat"], [5, 6, 1, "", "array_dims"], [5, 6, 1, "", "array_distinct"], [5, 6, 1, "", "array_element"], [5, 6, 1, "", "array_empty"], [5, 6, 1, "", "array_except"], [5, 6, 1, "", "array_extract"], [5, 6, 1, "", "array_has"], [5, 6, 1, "", "array_has_all"], [5, 6, 1, "", "array_has_any"], [5, 6, 1, "", "array_indexof"], [5, 6, 1, "", "array_intersect"], [5, 6, 1, "", "array_join"], [5, 6, 1, "", "array_length"], [5, 6, 1, "", "array_ndims"], [5, 6, 1, "", "array_pop_back"], [5, 6, 1, "", "array_pop_front"], [5, 6, 1, "", "array_position"], [5, 6, 1, "", "array_positions"], [5, 6, 1, "", "array_prepend"], [5, 6, 1, "", "array_push_back"], [5, 6, 1, "", "array_push_front"], [5, 6, 1, "", "array_remove"], [5, 6, 1, "", "array_remove_all"], [5, 6, 1, "", "array_remove_n"], [5, 6, 1, "", "array_repeat"], [5, 6, 1, "", "array_replace"], [5, 6, 1, "", "array_replace_all"], [5, 6, 1, "", "array_replace_n"], [5, 6, 1, "", "array_resize"], [5, 6, 1, "", "array_slice"], [5, 6, 1, "", "array_sort"], [5, 6, 1, "", "array_to_string"], [5, 6, 1, "", "array_union"], [5, 6, 1, "", "arrow_cast"], [5, 6, 1, "", "arrow_typeof"], [5, 6, 1, "", "ascii"], [5, 6, 1, "", "asin"], [5, 6, 1, "", "asinh"], [5, 6, 1, "", "atan"], [5, 6, 1, "", "atan2"], [5, 6, 1, "", "atanh"], [5, 6, 1, "", "avg"], [5, 6, 1, "", "bit_and"], [5, 6, 1, "", "bit_length"], [5, 6, 1, "", "bit_or"], [5, 6, 1, "", "bit_xor"], [5, 6, 1, "", "bool_and"], [5, 6, 1, "", "bool_or"], [5, 6, 1, "", "btrim"], [5, 6, 1, "", "cardinality"], [5, 6, 1, "", "case"], [5, 6, 1, "", "cbrt"], [5, 6, 1, "", "ceil"], [5, 6, 1, "", "char_length"], [5, 6, 1, "", "character_length"], [5, 6, 1, "", "chr"], [5, 6, 1, "", "coalesce"], [5, 6, 1, "", "col"], [5, 6, 1, "", "concat"], [5, 6, 1, "", "concat_ws"], [5, 6, 1, "", "corr"], [5, 6, 1, "", "cos"], [5, 6, 1, "", "cosh"], [5, 6, 1, "", "cot"], [5, 6, 1, "", "count"], [5, 6, 1, "", "count_star"], [5, 6, 1, "", "covar"], [5, 6, 1, "", "covar_pop"], [5, 6, 1, "", "covar_samp"], [5, 6, 1, "", "cume_dist"], [5, 6, 1, "", "current_date"], [5, 6, 1, "", "current_time"], [5, 6, 1, "", "date_bin"], [5, 6, 1, "", "date_part"], [5, 6, 1, "", "date_trunc"], [5, 6, 1, "", "datepart"], [5, 6, 1, "", "datetrunc"], [5, 6, 1, "", "decode"], [5, 6, 1, "", "degrees"], [5, 6, 1, "", "dense_rank"], [5, 6, 1, "", "digest"], [5, 6, 1, "", "empty"], [5, 6, 1, "", "encode"], [5, 6, 1, "", "ends_with"], [5, 6, 1, "", "exp"], [5, 6, 1, "", "extract"], [5, 6, 1, "", "factorial"], [5, 6, 1, "", "find_in_set"], [5, 6, 1, "", "first_value"], [5, 6, 1, "", "flatten"], [5, 6, 1, "", "floor"], [5, 6, 1, "", "from_unixtime"], [5, 6, 1, "", "gcd"], [5, 6, 1, "", "in_list"], [5, 6, 1, "", "initcap"], [5, 6, 1, "", "isnan"], [5, 6, 1, "", "iszero"], [5, 6, 1, "", "lag"], [5, 6, 1, "", "last_value"], [5, 6, 1, "", "lcm"], [5, 6, 1, "", "lead"], [5, 6, 1, "", "left"], [5, 6, 1, "", "length"], [5, 6, 1, "", "levenshtein"], [5, 6, 1, "", "list_append"], [5, 6, 1, "", "list_cat"], [5, 6, 1, "", "list_concat"], [5, 6, 1, "", "list_dims"], [5, 6, 1, "", "list_distinct"], [5, 6, 1, "", "list_element"], [5, 6, 1, "", "list_except"], [5, 6, 1, "", "list_extract"], [5, 6, 1, "", "list_indexof"], [5, 6, 1, "", "list_intersect"], [5, 6, 1, "", "list_join"], [5, 6, 1, "", "list_length"], [5, 6, 1, "", "list_ndims"], [5, 6, 1, "", "list_position"], [5, 6, 1, "", "list_positions"], [5, 6, 1, "", "list_prepend"], [5, 6, 1, "", "list_push_back"], [5, 6, 1, "", "list_push_front"], [5, 6, 1, "", "list_remove"], [5, 6, 1, "", "list_remove_all"], [5, 6, 1, "", "list_remove_n"], [5, 6, 1, "", "list_repeat"], [5, 6, 1, "", "list_replace"], [5, 6, 1, "", "list_replace_all"], [5, 6, 1, "", "list_replace_n"], [5, 6, 1, "", "list_resize"], [5, 6, 1, "", "list_slice"], [5, 6, 1, "", "list_sort"], [5, 6, 1, "", "list_to_string"], [5, 6, 1, "", "list_union"], [5, 6, 1, "", "ln"], [5, 6, 1, "", "log"], [5, 6, 1, "", "log10"], [5, 6, 1, "", "log2"], [5, 6, 1, "", "lower"], [5, 6, 1, "", "lpad"], [5, 6, 1, "", "ltrim"], [5, 6, 1, "", "make_array"], [5, 6, 1, "", "make_date"], [5, 6, 1, "", "make_list"], [5, 6, 1, "", "max"], [5, 6, 1, "", "md5"], [5, 6, 1, "", "mean"], [5, 6, 1, "", "median"], [5, 6, 1, "", "min"], [5, 6, 1, "", "named_struct"], [5, 6, 1, "", "nanvl"], [5, 6, 1, "", "now"], [5, 6, 1, "", "nth_value"], [5, 6, 1, "", "ntile"], [5, 6, 1, "", "nullif"], [5, 6, 1, "", "nvl"], [5, 6, 1, "", "octet_length"], [5, 6, 1, "", "order_by"], [5, 6, 1, "", "overlay"], [5, 6, 1, "", "percent_rank"], [5, 6, 1, "", "pi"], [5, 6, 1, "", "pow"], [5, 6, 1, "", "power"], [5, 6, 1, "", "radians"], [5, 6, 1, "", "random"], [5, 6, 1, "", "range"], [5, 6, 1, "", "rank"], [5, 6, 1, "", "regexp_count"], [5, 6, 1, "", "regexp_like"], [5, 6, 1, "", "regexp_match"], [5, 6, 1, "", "regexp_replace"], [5, 6, 1, "", "regr_avgx"], [5, 6, 1, "", "regr_avgy"], [5, 6, 1, "", "regr_count"], [5, 6, 1, "", "regr_intercept"], [5, 6, 1, "", "regr_r2"], [5, 6, 1, "", "regr_slope"], [5, 6, 1, "", "regr_sxx"], [5, 6, 1, "", "regr_sxy"], [5, 6, 1, "", "regr_syy"], [5, 6, 1, "", "repeat"], [5, 6, 1, "", "replace"], [5, 6, 1, "", "reverse"], [5, 6, 1, "", "right"], [5, 6, 1, "", "round"], [5, 6, 1, "", "row_number"], [5, 6, 1, "", "rpad"], [5, 6, 1, "", "rtrim"], [5, 6, 1, "", "sha224"], [5, 6, 1, "", "sha256"], [5, 6, 1, "", "sha384"], [5, 6, 1, "", "sha512"], [5, 6, 1, "", "signum"], [5, 6, 1, "", "sin"], [5, 6, 1, "", "sinh"], [5, 6, 1, "", "split_part"], [5, 6, 1, "", "sqrt"], [5, 6, 1, "", "starts_with"], [5, 6, 1, "", "stddev"], [5, 6, 1, "", "stddev_pop"], [5, 6, 1, "", "stddev_samp"], [5, 6, 1, "", "string_agg"], [5, 6, 1, "", "strpos"], [5, 6, 1, "", "struct"], [5, 6, 1, "", "substr"], [5, 6, 1, "", "substr_index"], [5, 6, 1, "", "substring"], [5, 6, 1, "", "sum"], [5, 6, 1, "", "tan"], [5, 6, 1, "", "tanh"], [5, 6, 1, "", "to_hex"], [5, 6, 1, "", "to_timestamp"], [5, 6, 1, "", "to_timestamp_micros"], [5, 6, 1, "", "to_timestamp_millis"], [5, 6, 1, "", "to_timestamp_nanos"], [5, 6, 1, "", "to_timestamp_seconds"], [5, 6, 1, "", "to_unixtime"], [5, 6, 1, "", "translate"], [5, 6, 1, "", "trim"], [5, 6, 1, "", "trunc"], [5, 6, 1, "", "upper"], [5, 6, 1, "", "uuid"], [5, 6, 1, "", "var"], [5, 6, 1, "", "var_pop"], [5, 6, 1, "", "var_samp"], [5, 6, 1, "", "var_sample"], [5, 6, 1, "", "when"], [5, 6, 1, "", "window"]], "datafusion.html_formatter": [[6, 1, 1, "", "CellFormatter"], [6, 1, 1, "", "DataFrameHtmlFormatter"], [6, 1, 1, "", "DefaultStyleProvider"], [6, 1, 1, "", "FormatterManager"], [6, 1, 1, "", "StyleProvider"], [6, 6, 1, "", "_refresh_formatter_reference"], [6, 6, 1, "", "_validate_bool"], [6, 6, 1, "", "_validate_positive_int"], [6, 6, 1, "", "configure_formatter"], [6, 6, 1, "", "get_formatter"], [6, 6, 1, "", "reset_formatter"], [6, 6, 1, "", "reset_styles_loaded_state"], [6, 6, 1, "", "set_formatter"]], "datafusion.html_formatter.CellFormatter": [[6, 2, 1, "", "__call__"]], "datafusion.html_formatter.DataFrameHtmlFormatter": [[6, 2, 1, "", "_build_expandable_cell"], [6, 2, 1, "", "_build_html_footer"], [6, 2, 1, "", "_build_html_header"], [6, 2, 1, "", "_build_regular_cell"], [6, 2, 1, "", "_build_table_body"], [6, 2, 1, "", "_build_table_container_start"], [6, 2, 1, "", "_build_table_header"], [6, 3, 1, "", "_custom_cell_builder"], [6, 3, 1, "", "_custom_header_builder"], [6, 2, 1, "", "_format_cell_value"], [6, 2, 1, "", "_get_cell_value"], [6, 2, 1, "", "_get_default_css"], [6, 2, 1, "", "_get_javascript"], [6, 3, 1, "", "_styles_loaded"], [6, 3, 1, "", "_type_formatters"], [6, 3, 1, "", "custom_css"], [6, 3, 1, "", "enable_cell_expansion"], [6, 2, 1, "", "format_html"], [6, 2, 1, "", "is_styles_loaded"], [6, 3, 1, "", "max_cell_length"], [6, 3, 1, "", "max_height"], [6, 3, 1, "", "max_memory_bytes"], [6, 3, 1, "", "max_width"], [6, 3, 1, "", "min_rows_display"], [6, 2, 1, "", "register_formatter"], [6, 3, 1, "", "repr_rows"], [6, 2, 1, "", "set_custom_cell_builder"], [6, 2, 1, "", "set_custom_header_builder"], [6, 3, 1, "", "show_truncation_message"], [6, 3, 1, "", "style_provider"], [6, 3, 1, "", "use_shared_styles"]], "datafusion.html_formatter.DefaultStyleProvider": [[6, 2, 1, "", "get_cell_style"], [6, 2, 1, "", "get_header_style"]], "datafusion.html_formatter.FormatterManager": [[6, 3, 1, "", "_default_formatter"], [6, 2, 1, "", "get_formatter"], [6, 2, 1, "", "set_formatter"]], "datafusion.html_formatter.StyleProvider": [[6, 2, 1, "", "get_cell_style"], [6, 2, 1, "", "get_header_style"]], "datafusion.input": [[9, 1, 1, "", "LocationInputPlugin"], [8, 0, 0, "-", "base"], [10, 0, 0, "-", "location"]], "datafusion.input.LocationInputPlugin": [[9, 2, 1, "", "build_table"], [9, 2, 1, "", "is_correct_input"]], "datafusion.input.base": [[8, 1, 1, "", "BaseInputSource"]], "datafusion.input.base.BaseInputSource": [[8, 2, 1, "", "build_table"], [8, 2, 1, "", "is_correct_input"]], "datafusion.input.location": [[10, 1, 1, "", "LocationInputPlugin"]], "datafusion.input.location.LocationInputPlugin": [[10, 2, 1, "", "build_table"], [10, 2, 1, "", "is_correct_input"]], "datafusion.io": [[11, 6, 1, "", "read_avro"], [11, 6, 1, "", "read_csv"], [11, 6, 1, "", "read_json"], [11, 6, 1, "", "read_parquet"]], "datafusion.object_store": [[12, 4, 1, "", "AmazonS3"], [12, 4, 1, "", "GoogleCloud"], [12, 4, 1, "", "Http"], [12, 4, 1, "", "LocalFileSystem"], [12, 4, 1, "", "MicrosoftAzure"]], "datafusion.plan": [[13, 1, 1, "", "ExecutionPlan"], [13, 1, 1, "", "LogicalPlan"]], "datafusion.plan.ExecutionPlan": [[13, 2, 1, "", "__repr__"], [13, 3, 1, "", "_raw_plan"], [13, 2, 1, "", "children"], [13, 2, 1, "", "display"], [13, 2, 1, "", "display_indent"], [13, 2, 1, "", "from_proto"], [13, 5, 1, "", "partition_count"], [13, 2, 1, "", "to_proto"]], "datafusion.plan.LogicalPlan": [[13, 2, 1, "", "__repr__"], [13, 3, 1, "", "_raw_plan"], [13, 2, 1, "", "display"], [13, 2, 1, "", "display_graphviz"], [13, 2, 1, "", "display_indent"], [13, 2, 1, "", "display_indent_schema"], [13, 2, 1, "", "from_proto"], [13, 2, 1, "", "inputs"], [13, 2, 1, "", "to_proto"], [13, 2, 1, "", "to_variant"]], "datafusion.record_batch": [[14, 1, 1, "", "RecordBatch"], [14, 1, 1, "", "RecordBatchStream"]], "datafusion.record_batch.RecordBatch": [[14, 3, 1, "", "record_batch"], [14, 2, 1, "", "to_pyarrow"]], "datafusion.record_batch.RecordBatchStream": [[14, 2, 1, "", "__aiter__"], [14, 2, 1, "", "__anext__"], [14, 2, 1, "", "__iter__"], [14, 2, 1, "", "__next__"], [14, 2, 1, "", "next"], [14, 3, 1, "", "rbs"]], "datafusion.substrait": [[15, 1, 1, "", "Consumer"], [15, 1, 1, "", "Plan"], [15, 1, 1, "", "Producer"], [15, 1, 1, "", "Serde"]], "datafusion.substrait.Consumer": [[15, 2, 1, "", "from_substrait_plan"]], "datafusion.substrait.Plan": [[15, 2, 1, "", "encode"], [15, 3, 1, "", "plan_internal"]], "datafusion.substrait.Producer": [[15, 2, 1, "", "to_substrait_plan"]], "datafusion.substrait.Serde": [[15, 2, 1, "", "deserialize"], [15, 2, 1, "", "deserialize_bytes"], [15, 2, 1, "", "serialize"], [15, 2, 1, "", "serialize_bytes"], [15, 2, 1, "", "serialize_to_plan"]], "datafusion.unparser": [[17, 1, 1, "", "Dialect"], [17, 1, 1, "", "Unparser"]], "datafusion.unparser.Dialect": [[17, 2, 1, "", "default"], [17, 3, 1, "", "dialect"], [17, 2, 1, "", "duckdb"], [17, 2, 1, "", "mysql"], [17, 2, 1, "", "postgres"], [17, 2, 1, "", "sqlite"]], "datafusion.unparser.Unparser": [[17, 2, 1, "", "plan_to_sql"], [17, 3, 1, "", "unparser"], [17, 2, 1, "", "with_pretty"]], "datafusion.user_defined": [[18, 1, 1, "", "Accumulator"], [18, 1, 1, "", "AggregateUDF"], [18, 1, 1, "", "ScalarUDF"], [18, 1, 1, "", "TableFunction"], [18, 1, 1, "", "Volatility"], [18, 1, 1, "", "WindowEvaluator"], [18, 1, 1, "", "WindowUDF"], [18, 4, 1, "", "_R"], [18, 4, 1, "", "udaf"], [18, 4, 1, "", "udf"], [18, 4, 1, "", "udtf"], [18, 4, 1, "", "udwf"]], "datafusion.user_defined.Accumulator": [[18, 2, 1, "", "evaluate"], [18, 2, 1, "", "merge"], [18, 2, 1, "", "state"], [18, 2, 1, "", "update"]], "datafusion.user_defined.AggregateUDF": [[18, 2, 1, "", "__call__"], [18, 3, 1, "", "_udaf"], [18, 2, 1, "", "udaf"]], "datafusion.user_defined.ScalarUDF": [[18, 2, 1, "", "__call__"], [18, 3, 1, "", "_udf"], [18, 2, 1, "", "udf"]], "datafusion.user_defined.TableFunction": [[18, 2, 1, "", "__call__"], [18, 2, 1, "", "__repr__"], [18, 2, 1, "", "_create_table_udf"], [18, 2, 1, "", "_create_table_udf_decorator"], [18, 3, 1, "", "_udtf"], [18, 2, 1, "", "udtf"]], "datafusion.user_defined.Volatility": [[18, 3, 1, "", "Immutable"], [18, 3, 1, "", "Stable"], [18, 3, 1, "", "Volatile"], [18, 2, 1, "", "__str__"]], "datafusion.user_defined.WindowEvaluator": [[18, 2, 1, "", "evaluate"], [18, 2, 1, "", "evaluate_all"], [18, 2, 1, "", "evaluate_all_with_rank"], [18, 2, 1, "", "get_range"], [18, 2, 1, "", "include_rank"], [18, 2, 1, "", "is_causal"], [18, 2, 1, "", "memoize"], [18, 2, 1, "", "supports_bounded_execution"], [18, 2, 1, "", "uses_window_frame"]], "datafusion.user_defined.WindowUDF": [[18, 2, 1, "", "__call__"], [18, 2, 1, "", "_create_window_udf"], [18, 2, 1, "", "_create_window_udf_decorator"], [18, 2, 1, "", "_get_default_name"], [18, 2, 1, "", "_normalize_input_types"], [18, 3, 1, "", "_udwf"], [18, 2, 1, "", "udwf"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "data", "Python data"], "5": ["py", "property", "Python property"], "6": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute", "4": "py:data", "5": "py:property", "6": "py:function"}, "terms": {"": [2, 3, 4, 5, 6, 7, 18, 20, 21, 26, 27, 29, 31, 32, 33, 34, 36], "0": [3, 4, 5, 7, 18, 23, 24, 25, 26, 27, 30, 31, 33, 35, 36, 37, 44, 45], "007bff": 36, "01": [23, 27, 30], "01t00": 27, "0301050905471": 25, "04023": 5, "05": [27, 30], "06": [27, 30], "08": 27, "09": [23, 27], "1": [3, 4, 5, 7, 18, 19, 21, 22, 23, 24, 25, 26, 27, 29, 30, 31, 32, 33, 35, 37, 38, 45], "10": [4, 5, 6, 7, 18, 22, 23, 24, 26, 27, 30, 31, 32, 33, 35, 36, 37, 45], "100": [5, 6, 22, 23, 24, 33, 35, 36, 37], "1000": [2, 6, 7, 11, 25, 36], "10000000": 34, "1024": [2, 6, 7, 36], "103": [22, 35, 37], "104": [22, 35, 37], "105": [22, 24, 35, 37], "107": 24, "109": [22, 35, 37, 45], "11": [22, 23, 24, 26, 27, 31, 33, 35, 37], "110": 24, "111": [22, 35, 37], "112": 24, "115": [22, 24, 35, 37], "12": [21, 22, 23, 24, 26, 27, 31, 33, 35, 37], "120": [5, 22, 24, 35, 37], "121": 24, "122": [22, 35, 37], "123": [22, 35, 37], "12371": 5, "125": [5, 24, 27, 45], "128": [4, 5, 7], "13": [22, 24, 26, 27, 31, 33, 35, 37], "130": [22, 35, 37], "135": [22, 35, 37], "136": 24, "14": [22, 23, 24, 26, 27, 30, 31, 35, 37], "140": 24, "145": [22, 24, 35, 37], "149": 45, "15": [22, 23, 24, 26, 27, 30, 31, 33, 35, 37], "150": [22, 33, 35, 37], "158": 45, "159": [22, 35, 37, 45], "16": [23, 24, 26, 27, 31], "160": 45, "161": 45, "162": 45, "163": 45, "165": [27, 45], "17": [23, 24, 26, 27, 31, 33], "18": [23, 24, 26, 27, 31, 33], "186": 25, "19": [24, 26, 27, 45], "190": 45, "1902": 5, "1921": 27, "195": [22, 35, 37], "1970": 27, "1px": 36, "2": [3, 4, 5, 6, 7, 18, 22, 23, 24, 25, 26, 27, 29, 30, 31, 32, 33, 35, 37, 38, 45], "20": [3, 5, 6, 7, 18, 22, 24, 26, 27, 32, 33, 35, 36, 37, 45], "200": 45, "2021": 23, "2025": 27, "205": [22, 35, 37], "2097152": [6, 36], "21": [23, 24, 26, 27, 33], "22": [3, 26, 35], "223": 45, "224": [4, 5, 7], "229": 45, "23": [23, 26, 33, 45], "23076923076923": 24, "2345": 5, "24": [23, 26], "25": [5, 6, 22, 24, 26, 27, 33, 35, 36, 37], "256": [4, 5, 7], "25806451612904": 24, "26": [26, 33], "27": 26, "28": [23, 26, 33], "28571428571429": 24, "28t18": 27, "29": 26, "2mb": [6, 36], "3": [3, 5, 18, 21, 22, 23, 24, 25, 26, 27, 29, 30, 31, 32, 33, 35, 37, 38, 45], "30": [22, 24, 26, 32, 33, 35, 37], "300": [6, 36], "309": [22, 27, 35, 37], "31": 26, "314": [22, 27, 35, 37], "316": 25, "318": [22, 27, 35, 37], "32": 26, "33": [23, 26], "333333333333332": 33, "333333333333336": 24, "34": [26, 27], "343210340z": 27, "35": [22, 23, 24, 26, 30, 33, 35, 37], "36": [23, 26], "37": [26, 27], "38": [26, 27], "384": [4, 5, 7], "39": [22, 26, 35, 37, 45], "395": [22, 35, 37], "3rd": 5, "4": [3, 5, 18, 22, 23, 24, 25, 26, 27, 29, 30, 31, 32, 33, 35, 36, 37, 38, 45], "40": [5, 21, 22, 24, 26, 32, 35, 37], "405": [22, 27, 35, 37], "41": 26, "42": [24, 26, 33, 35], "42857142857143": 33, "43": [22, 26, 33, 35, 37, 44], "44": [22, 26, 35, 37], "45": [22, 24, 26, 27, 33, 35, 37], "4579": 27, "46": 24, "47": [24, 37], "4732": 27, "48": [22, 24, 35, 37], "49": [22, 35, 37], "495": [22, 35, 37], "4mb": 36, "5": [3, 5, 18, 22, 23, 24, 25, 26, 27, 29, 30, 31, 32, 33, 35, 37, 38, 45], "50": [5, 6, 7, 22, 24, 32, 35, 36, 37], "500": [6, 7], "51": [23, 24], "512": [4, 5, 7], "5129": 27, "513": 25, "52": [22, 24, 35, 37], "525": [22, 27, 35, 37], "53": 24, "530": [22, 35, 37], "534": [22, 27, 35, 37], "54": [24, 26, 27], "55": [22, 24, 33, 35, 37], "56": 24, "568": 25, "579": 25, "58": [22, 24, 35, 37], "5811388300841898": 25, "59": [22, 35, 37], "6": [22, 23, 24, 25, 26, 27, 29, 30, 31, 33, 35, 37, 38, 45], "60": [5, 22, 24, 33, 35, 37], "62": [22, 35, 37], "625": [22, 27, 35, 37], "63": [22, 24, 35, 37], "630": [22, 35, 37], "634": [22, 27, 35, 37], "64": [21, 22, 33, 35, 37], "65": [22, 24, 26, 30, 33, 35, 37], "66": [23, 24], "666666666666668": 33, "66666666666667": 24, "666667": 5, "67": [24, 26], "698": 25, "7": [22, 23, 24, 25, 26, 27, 29, 30, 31, 33, 35, 37, 38, 45], "70": [22, 24, 33, 35, 37], "71": [24, 26], "72": 24, "73": 23, "732": 27, "75": [5, 22, 24, 35, 37], "76": 33, "77777777777777": 24, "78": [22, 23, 35, 37], "785714285714285": 24, "78571428571429": 24, "79": [22, 23, 35, 37], "8": [22, 23, 24, 25, 26, 27, 29, 30, 31, 33, 34, 35, 37, 38], "80": [5, 22, 24, 33, 35, 37], "804": 25, "81": 23, "82": [22, 35, 37], "83": [22, 24, 35, 37], "833333333333336": 24, "84": [22, 33, 35, 37], "85": [22, 24, 35, 37], "855": 27, "86": 24, "86740bfd3d9831d6b7c1d0e1bf4a21d91598a0ac": [4, 7], "88888888888889": 24, "8px": 36, "9": [5, 21, 22, 23, 24, 25, 26, 27, 29, 30, 31, 33, 35, 37, 38, 45], "90": [5, 22, 24, 33, 35, 37], "91": 24, "92": 23, "94": [23, 30], "95": [23, 24, 33, 45], "96": [23, 24], "972": 27, "98": [24, 45], "A": [2, 3, 4, 5, 7, 8, 13, 15, 18, 23, 25, 29, 33, 36, 44], "AND": [3, 4, 5, 7, 18], "As": [5, 7, 18, 20, 26, 30, 35], "At": [5, 20], "BY": 18, "Be": 3, "By": [3, 20, 21, 24], "For": [2, 3, 5, 15, 17, 18, 20, 21, 23, 24, 26, 27, 29, 30, 31, 36, 37], "INTO": [2, 7], "If": [2, 3, 4, 5, 6, 7, 8, 11, 18, 20, 21, 24, 27, 29, 31, 33, 37, 44], "In": [18, 20, 21, 22, 23, 24, 25, 26, 27, 29, 30, 31, 33, 35, 37, 38, 45], "It": [2, 3, 4, 5, 6, 7, 18, 20, 22, 23, 24, 26, 29, 36, 38, 43], "Its": 22, "No": 3, "Not": [4, 7], "OR": [4, 5, 7], "On": [3, 20, 35], "One": [3, 4, 20, 24, 33], "Or": 36, "That": [4, 7, 38], "The": [2, 3, 4, 5, 6, 7, 9, 10, 11, 13, 15, 18, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 33, 35, 36], "Then": 31, "There": [5, 27, 31], "These": [5, 7, 14, 18, 24, 26, 31, 34, 36], "To": [3, 5, 20, 21, 26, 27, 30, 31, 33, 35, 37, 38, 44], "Will": [3, 36], "With": [4, 7, 37, 38], "__add__": [4, 7], "__aiter__": [7, 14], "__and__": [4, 7], "__anext__": [7, 14], "__arrow_c_array__": [2, 38], "__arrow_c_stream__": [2, 3, 38], "__call__": [6, 7, 18], "__datafusion_table_function__": 31, "__datafusion_table_provider__": [2, 20, 44], "__eq__": [4, 7], "__ge__": [4, 7], "__getitem__": [3, 4, 7], "__gt__": [4, 7], "__init__": [7, 18, 31], "__invert__": [4, 7], "__iter__": [7, 14], "__le__": [4, 7], "__lt__": [4, 7], "__mod__": [4, 7], "__mul__": [4, 7], "__ne__": [4, 7], "__next__": [7, 14], "__or__": [4, 7], "__radd__": [4, 7], "__rand__": [4, 7], "__repr__": [3, 4, 7, 13, 18, 36], "__richcmp__": [4, 7], "__rmod__": [4, 7], "__rmul__": [4, 7], "__ror__": [4, 7], "__rsub__": [4, 7], "__rtruediv__": [4, 7], "__str__": 18, "__sub__": [4, 7], "__truediv__": [4, 7], "__version__": 37, "_aggreg": 5, "_build_expandable_cel": 6, "_build_html_foot": 6, "_build_html_head": 6, "_build_regular_cel": 6, "_build_table_bodi": 6, "_build_table_container_start": 6, "_build_table_head": 6, "_create_table_udf": [7, 18], "_create_table_udf_decor": [7, 18], "_create_window_udf": [7, 18], "_create_window_udf_decor": [7, 18], "_custom_cell_build": 6, "_custom_header_build": 6, "_default_formatt": 6, "_format_cell_valu": 6, "_get_cell_valu": 6, "_get_default_css": 6, "_get_default_nam": [7, 18], "_get_javascript": 6, "_intern": [0, 3, 4, 7, 13, 14, 15, 17], "_io_custom_table_provid": 31, "_normalize_input_typ": [7, 18], "_null_treat": 4, "_order_bi": 4, "_partition_bi": 4, "_r": [7, 18], "_raw_plan": [7, 13], "_refresh_formatter_refer": 6, "_repr_html_": [3, 6, 36], "_styles_load": 6, "_sum": [7, 18, 31], "_to_pyarrow_typ": [4, 7], "_type_formatt": 6, "_udaf": [7, 18], "_udf": [7, 18], "_udtf": [7, 18], "_udwf": [7, 18], "_validate_bool": 6, "_validate_positive_int": 6, "_window_fram": 4, "_window_funct": 5, "a0": 26, "a_siz": 26, "ab": [4, 5, 7], "abc": 8, "abi": 20, "abi3": 21, "abi_st": 20, "abil": 35, "abilti": 35, "abl": [7, 13], "about": [15, 17, 20, 22, 33, 34], "abov": [5, 20, 24, 33], "absolut": [4, 5, 7], "abstract": [7, 8, 18, 26, 31], "accept": [2, 4, 7, 38], "access": [6, 7, 11, 20, 26, 35], "access_key_id": 35, "account": 35, "accum": [7, 18], "accumul": [7, 18, 31], "achiev": 22, "aco": [4, 5, 7], "acosh": [4, 5, 7], "acronym": 20, "across": [6, 18, 20, 26, 36], "act": [7, 13], "activ": [20, 21], "actual": [3, 36], "ad": 3, "adapt": 20, "add": [2, 3, 4, 5, 6, 20, 21], "add_3": 3, "addit": [3, 4, 5, 6, 7, 15, 17, 18, 20, 21, 31, 35, 36], "addition": [20, 23], "adhoc": 21, "adopt": 20, "advanc": [35, 36], "advantag": [20, 21, 22], "affect": [18, 24, 36], "after": [3, 4, 5, 7, 18, 31, 36], "ag": [26, 36], "against": [2, 4, 5, 18, 20, 22, 32, 36], "age_col": 26, "age_in_year": 26, "agg": 3, "aggreg": [2, 3, 4, 5, 7, 18, 23, 28, 36], "aggregatefunct": 4, "aggregateudf": [2, 7, 18], "aim": 37, "albert": 26, "algorithm": [3, 5], "alia": [2, 3, 4, 5, 7, 23, 24, 26, 27, 30, 31, 33, 38], "alias": 21, "alic": 29, "align": 36, "all": [0, 2, 3, 4, 5, 6, 7, 18, 20, 21, 23, 24, 27, 29, 30, 31, 33, 35, 36], "alloc": 3, "allow": [2, 6, 7, 18, 20, 21, 22, 24, 26, 27, 31, 36], "alpha": [31, 35], "alreadi": [5, 20], "also": [2, 3, 6, 7, 18, 20, 21, 22, 24, 26, 27, 31, 33, 36, 37, 45], "altern": [30, 40, 43], "alternate_a": 3, "alwai": [18, 36], "amazons3": [12, 35], "amount": [3, 18], "an": [2, 3, 4, 5, 6, 7, 11, 13, 15, 18, 20, 21, 23, 24, 25, 26, 29, 30, 31, 33, 35, 37, 38, 39, 40, 43], "analyt": 33, "analyz": [3, 4, 21], "ani": [2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 18, 20, 24, 29, 31, 33, 35, 38], "anoth": [3, 5, 7, 11, 20], "anti": [3, 28], "apach": [2, 4, 5, 7, 20, 21, 22, 38], "apart": 22, "api": [2, 7, 13, 20, 21, 22, 27, 33, 34, 36, 45], "appear": [4, 5, 7, 20, 36], "append": [5, 31], "appli": [3, 6, 36], "applic": 20, "approach": [5, 24, 26], "appropri": [18, 21, 35], "approx_distinct": [5, 24], "approx_median": [5, 24], "approx_percentile_cont": [5, 24], "approx_percentile_cont_with_weight": [5, 24], "approxim": [5, 24], "ar": [2, 3, 4, 5, 6, 7, 11, 13, 14, 18, 20, 21, 23, 24, 26, 28, 30, 31, 33, 35, 36, 37, 38], "arbitrari": [3, 5], "arc": [4, 5, 7, 20, 31, 44], "area": 20, "arg": [2, 3, 5, 7, 15, 18, 21], "argument": [3, 4, 5, 7, 18, 24, 31], "around": [5, 21], "arrai": [2, 3, 4, 5, 6, 7, 18, 24, 28, 31, 35, 38], "array1": 5, "array2": 5, "array_agg": [5, 24], "array_append": [5, 21], "array_cat": [5, 26], "array_concat": [5, 26], "array_dim": [4, 5, 7], "array_distinct": [4, 5, 7], "array_el": [4, 5, 7, 26], "array_empti": [4, 5, 7, 26], "array_except": 5, "array_extract": 5, "array_ha": 5, "array_has_al": 5, "array_has_ani": 5, "array_indexof": 5, "array_intersect": 5, "array_join": 5, "array_length": [4, 5, 7], "array_ndim": [4, 5, 7], "array_pop_back": [4, 5, 7], "array_pop_front": [4, 5, 7], "array_posit": 5, "array_prepend": 5, "array_push_back": 5, "array_push_front": 5, "array_remov": 5, "array_remove_al": 5, "array_remove_n": 5, "array_repeat": [5, 26], "array_replac": 5, "array_replace_al": 5, "array_replace_n": 5, "array_res": 5, "array_slic": 5, "array_sort": 5, "array_to_str": 5, "array_union": 5, "arrow": [2, 3, 4, 5, 6, 7, 21, 22, 25, 35, 36, 37, 41], "arrow_cast": [4, 5, 7, 27], "arrow_datafusion_python_root": 21, "arrow_typeof": [4, 5, 7], "arrowarrayexport": 2, "arrowstreamexport": 2, "arxiv": 5, "as_pi": [7, 18, 31], "ascend": [4, 5, 7, 24, 33], "ascii": [4, 5, 7], "asin": [4, 5, 7], "asinh": [4, 5, 7], "assembl": 2, "assign": [4, 5, 7], "assist": 21, "associ": [0, 2, 4, 5, 7, 20], "assum": [3, 5, 21, 35], "assumpt": 22, "async": [7, 14], "atan": [4, 5, 7], "atan2": 5, "atanh": [4, 5, 7], "atk": [22, 35, 37], "attach": [4, 5, 7], "attack": [22, 24, 27, 33, 35, 37, 45], "attempt": [2, 3, 7, 18, 20, 21], "auto": 19, "autoapi": 19, "automat": [2, 7, 36], "avail": [3, 6, 24, 28, 31, 34, 44], "availbl": 33, "averag": [5, 18, 33], "avg": [5, 18, 24, 33], "avoid": [2, 7, 11], "avro": [2, 7, 11, 35, 41], "awar": [3, 30], "aws_access_key_id": 35, "aws_secret_access_kei": 35, "b": [3, 5, 25, 26, 31, 32, 35, 38], "back": [4, 20, 22, 31, 36, 38], "background": 36, "balanc": 36, "bar": 34, "base": [2, 3, 4, 5, 6, 7, 9, 10, 11, 18, 19, 26, 29, 31], "base64": 5, "baseinputsourc": [8, 9, 10], "basi": [7, 18, 31], "basic": [23, 28, 30, 31], "basic_typ": 27, "batch": [2, 3, 6, 7, 13, 14, 18, 25, 31, 32, 35, 36, 38], "batch_arrai": 31, "batch_siz": [2, 7], "becaus": [4, 7, 31], "becca": 26, "beedril": [22, 33, 35, 37], "beedrillmega": [22, 33, 35, 37], "been": [6, 20], "befor": [5, 6, 21, 26, 31, 36], "beforehand": [2, 7], "begin": [2, 4, 5, 7, 18], "beginnig": 5, "being": 3, "below": [23, 24, 35], "benefit": 36, "best": [2, 7, 20], "beta": 35, "better": 3, "between": [2, 4, 5, 6, 7, 18, 20, 22, 23, 29, 31, 33], "betwen": 33, "bia": [7, 18], "bias_10": [7, 18], "biased_numb": [7, 18], "biasednumb": [7, 18], "bin": [5, 21], "binari": [4, 5, 7, 13, 20], "binaryexpr": [4, 7], "bind": [7, 22, 37], "bit": [4, 5, 7], "bit_and": [5, 24], "bit_length": [4, 5, 7], "bit_or": [5, 24], "bit_xor": [5, 24], "bitwis": [5, 26], "blake2": 5, "blake2b": 5, "blake3": 5, "blastois": [22, 35, 37], "blastoisemega": [22, 35, 37], "blob": [4, 7], "blog": 21, "blue": 26, "bob": 29, "bodi": 6, "bool": [2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 17, 18], "bool_": 31, "bool_and": [5, 24], "bool_or": [5, 24], "boolean": [4, 5, 6, 7, 28], "bootstrap": 21, "border": 36, "both": [3, 4, 5, 7, 18, 20, 21, 26, 29, 31], "bound": [4, 7, 18, 31, 33, 44], "boundari": [18, 20, 33], "bow": 33, "box": 20, "bracket": 26, "break": 20, "bronz": 5, "brotli": 3, "btrim": [4, 5, 7], "bucket_nam": 35, "bug": [22, 24, 33, 35, 37], "build": [4, 5, 6, 7, 20, 22, 23, 24, 33, 36], "build_flag": 21, "build_tabl": [8, 9, 10], "builder": [4, 5, 6, 24, 33], "built": [18, 20, 24, 26, 27, 31], "bulb": 27, "bulbafleur": 27, "bulbasaur": [22, 27, 33, 35, 37], "bulk": 20, "butterfre": [22, 33, 35, 37], "button": 6, "byte": [2, 4, 5, 6, 7, 13, 15], "c": [2, 3, 18, 20, 21, 22, 25, 35, 38], "cach": [3, 6], "calcul": [3, 5, 18, 31], "call": [0, 2, 3, 4, 5, 6, 7, 13, 14, 15, 17, 18, 20, 23, 24, 26, 31, 36, 38], "callabl": [3, 6, 7, 18], "calll": 26, "can": [2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 18, 20, 21, 23, 24, 26, 30, 31, 32, 33, 34, 35, 36, 37, 38, 44], "can_retir": 26, "cannot": 5, "canon": 20, "canonical_nam": [4, 7], "capit": [4, 5, 7, 30], "capsul": 20, "cardin": [4, 5, 7, 26], "carefulli": 20, "cargo": 21, "carlo": 26, "case": [3, 4, 5, 7, 18, 20, 24, 27, 30, 31, 33, 35], "case_build": 4, "casebuild": [4, 5], "cast": [3, 4, 5, 7, 28], "castabl": [4, 7], "catalog": [2, 7, 17, 19], "categori": [3, 27], "caterpi": [22, 33, 35, 37], "caus": [2, 7, 21, 33, 38], "cbrt": [4, 5, 7], "cdatainterfac": 2, "ceil": [4, 5, 7], "cell": [6, 36], "cellformatt": 6, "certain": 18, "certainli": 21, "chain": 3, "challeng": 20, "chang": [6, 18, 21, 26, 36], "chansei": 24, "char": 27, "char_length": [4, 5, 7, 27], "charact": [4, 5, 6, 7, 36], "character_length": [4, 5, 7], "charizard": [22, 27, 33, 35, 37], "charizardmega": [22, 27, 33, 35, 37], "charli": 29, "charmand": [22, 27, 33, 35, 37], "charmeleon": [22, 27, 33, 35, 37], "check": [5, 6, 26, 27], "checksum": [4, 5, 7], "child": 36, "children": [7, 13], "chr": [4, 5, 7], "chrono": 5, "ci": [20, 21], "citycab": 29, "class": [1, 31, 36], "classmethod": [2, 3, 6], "classvar": [4, 7], "claus": [18, 33], "clean": 21, "clefabl": 33, "clefairi": [24, 33], "click": 6, "clone": [21, 31, 44], "close": 33, "co": [4, 5, 7], "coalesc": [5, 27], "code": [4, 5, 6, 7, 20, 27], "codebas": 21, "coeffici": 5, "coerc": 5, "col": [3, 4, 5, 6, 7, 18, 19, 23, 24, 26, 27, 30, 31, 32, 33, 36, 38, 45], "col1": 18, "col_attack": 24, "col_diff": 31, "col_idx": 6, "col_spe": 24, "col_type_1": 24, "col_type_2": 24, "collaps": [6, 36], "collect": [3, 22, 23, 25, 32, 36, 38, 45], "collect_partit": 3, "color": [26, 36], "column": [1, 2, 3, 4, 5, 6, 7, 11, 18, 23, 24, 25, 27, 28, 29, 31, 33, 45], "column_a": 4, "column_nam": [4, 7], "com": [4, 5, 7, 21], "combin": [3, 5, 26, 29, 30, 31], "come": [35, 42], "command": [2, 7, 21], "common": [4, 5, 7, 8, 9, 10, 24, 27, 29, 33, 38], "commun": [20, 21], "compar": [5, 33], "comparison": [4, 7, 24], "compat": [20, 26], "compil": [20, 26], "complet": [4, 5, 7, 8, 20, 21, 31, 36, 44], "complex": [3, 22, 27], "complic": 3, "compon": 5, "compos": [5, 36], "composit": 6, "comprehens": 36, "compress": [2, 3, 7, 11], "compression_level": 3, "comput": [3, 4, 5, 7, 18, 20, 26, 31], "concat": 5, "concat_w": 5, "concaten": [5, 26], "concatenated_arrai": 26, "concept": [2, 3, 4, 7, 26], "concis": 21, "concurr": [2, 7], "condit": 28, "config": [2, 7, 21, 34], "config_intern": [2, 7], "config_opt": [2, 7], "configur": [2, 6, 7, 21, 36], "configure_formatt": [6, 7, 36], "conflict": [2, 7, 11], "conjunct": 3, "connect": [2, 23], "consecut": 5, "consid": 5, "consider": 36, "consist": [5, 36], "consol": 3, "construct": [4, 7, 18, 31], "constructor": [0, 3, 4, 7, 13, 14, 15, 17, 18], "consum": [8, 15, 38], "contain": [3, 5, 6, 7, 13, 18, 19, 20, 21, 24, 26, 29, 31], "content": [21, 28], "context": [5, 6, 7, 11, 13, 15, 19, 31, 32, 34, 36, 38, 45], "continu": [5, 20], "contribut": 21, "control": [2, 7, 24, 33], "conveni": [7, 18, 35], "convent": 20, "convers": [20, 21, 23], "convert": [2, 3, 4, 5, 7, 13, 14, 15, 17, 18, 20, 23, 25, 26, 27, 31, 32, 45], "copi": [20, 21, 22, 31, 38], "copyto": 4, "core": [3, 4, 7, 20], "corr": [5, 24], "correctli": [3, 18], "correl": 5, "correspond": [5, 29], "cosh": [4, 5, 7], "cosin": [4, 5, 7], "cost": 22, "costli": 18, "cot": [4, 5, 7], "cotang": [4, 5, 7], "could": [3, 4, 7, 20], "count": [3, 5, 24, 25], "count_star": 5, "counterpart": [5, 20], "coupl": [20, 33], "covar": 5, "covar_pop": [5, 24], "covar_samp": [5, 24], "covari": 5, "cover": [23, 27, 34], "cpython": 21, "cr": 31, "crate": 20, "creat": [2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 15, 17, 18, 19, 20, 21, 23, 24, 26, 32, 34, 38, 45], "create_datafram": [2, 31, 35], "create_dataframe_from_logical_plan": 2, "createcatalog": 4, "createcatalogschema": 4, "createexternalt": 4, "createfunct": 4, "createfunctionbodi": 4, "createindex": 4, "creatememoryt": 4, "createview": 4, "credenti": 35, "criteria": [5, 33], "css": [6, 36], "cstream": 20, "cstring": [20, 44], "csv": [2, 3, 7, 11, 20, 22, 24, 27, 33, 35, 36, 37, 41, 45], "ctx": [2, 5, 7, 13, 15, 22, 23, 24, 25, 26, 27, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 42, 43, 44, 45], "cube": [4, 5, 7], "cubon": 24, "cume_dist": [5, 18, 33], "cumul": 5, "curr_valu": 31, "current": [3, 4, 5, 6, 7, 13, 18, 20, 27, 31, 33, 36], "current_d": 5, "current_tim": 5, "custom": [2, 6, 7, 8, 13, 20, 29, 31, 41], "custom_css": [6, 36], "custom_formatt": 6, "custom_html": 36, "customer_id": 29, "d": [3, 18, 38], "dai": [5, 27], "dant": 26, "dark": [24, 36], "data": [0, 2, 3, 4, 5, 6, 7, 11, 13, 17, 18, 20, 21, 22, 23, 24, 25, 26, 27, 30, 31, 32, 33, 36, 37, 38, 39, 42, 44], "data_typ": 5, "databas": [0, 7, 26], "dataflow": [7, 13], "datafram": [2, 4, 5, 6, 7, 11, 13, 14, 18, 19, 22, 24, 25, 26, 27, 29, 30, 31, 32, 33, 37, 38, 45], "dataframehtmlformatt": 6, "datafrm": 3, "datafus": [19, 20, 21, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 43, 44, 45], "datafusion_df": 35, "datafusion_sql": 17, "datafusion_table_funct": 31, "datafusion_table_provid": [20, 44], "dataset": [2, 27, 33, 35, 37], "datasourc": 8, "datastructur": [4, 7], "datatyp": [3, 4, 7, 18], "datatypemap": [4, 7], "date": [5, 27], "date32": 5, "date_bin": 5, "date_part": [5, 27], "date_trunc": 5, "datepart": 5, "datetrunc": 5, "db": [0, 7], "ddd": 36, "ddl": [2, 7], "dealloc": 4, "debug": 6, "decid": [18, 20], "decim": 5, "decimal_plac": 5, "decod": 5, "decor": [7, 18], "def": [3, 7, 18, 22, 31, 35, 36, 37], "default": [2, 3, 4, 5, 6, 7, 10, 11, 17, 18, 20, 21, 31, 33, 34, 36], "default_valu": 5, "defaultstyleprovid": 6, "defens": [22, 27, 35, 37, 45], "defin": [2, 4, 7, 16, 18, 20, 21, 27, 28, 33], "definit": [2, 4, 7, 18, 20, 23, 31], "degre": [4, 5, 7], "delet": [2, 7], "delimit": [2, 5, 7, 11], "delta": 20, "delta_t": 35, "deltalak": 35, "deltat": 35, "demonstr": [2, 31, 33, 37, 38], "dens": 5, "dense_rank": [5, 18, 33], "depend": [5, 20, 24, 31, 33], "deprec": [3, 5, 16, 33], "deregister_t": 2, "descend": 5, "describ": [3, 5, 20, 24, 25, 31, 35], "describet": 4, "descript": [5, 7, 18], "deseri": 15, "deserialize_byt": 15, "design": [20, 28], "desir": 5, "detafram": 2, "detail": [3, 4, 5, 7, 18, 21, 23, 25], "determin": [3, 4, 5, 7, 31], "dev": 21, "develop": 20, "deviat": 5, "df": [2, 3, 4, 5, 22, 23, 24, 25, 26, 27, 30, 31, 32, 33, 35, 36, 37, 38, 39, 40, 42, 43, 45], "df_filter": 32, "df_view": 32, "dfschema": 7, "dialect": 17, "dict": [2, 3, 4, 5, 6, 7], "dictionari": [2, 3, 5, 26, 32, 35], "differ": [3, 4, 5, 7, 13, 18, 20, 27, 31, 35, 36], "difficult": 20, "digest": 5, "dimens": [4, 5, 7], "dimension": 3, "directli": [4, 5, 6, 15, 35, 36, 38], "directori": [2, 7, 21], "disabl": [2, 7], "discard": 3, "discuss": 20, "disk": [2, 7, 9, 10], "displai": [6, 7, 13, 23, 25, 32, 37], "display_graphviz": [7, 13], "display_ind": [7, 13], "display_indent_schema": [7, 13], "display_nam": [4, 7], "distanc": 5, "distinct": [3, 4, 5, 7], "distinctli": 20, "distinguish": 20, "distribut": 5, "div": 36, "divid": 5, "divis": [4, 5, 7], "divisor": 5, "dml": [2, 7], "dmlstatement": 4, "do": [2, 7, 18, 20, 21, 23, 24, 31, 33, 35, 44], "doc": [2, 5, 17], "docstr": 21, "document": [2, 3, 4, 5, 7, 19, 20, 21, 23, 34, 37], "doe": [3, 5, 6, 18, 20, 21, 33, 35], "doesn": 18, "dominant_typ": 27, "done": [3, 24, 31], "dot": [7, 13], "doubl": [30, 38], "double_func": [7, 18], "double_it": [7, 18], "double_udf": [7, 18], "down": [20, 33, 35], "downcast": 20, "download": [23, 30, 37], "dragon": [22, 24, 27, 33, 35, 37], "dragonair": 33, "dratini": 33, "drop": [2, 3, 7], "dropcatalogschema": 4, "dropfunct": 4, "droptabl": 4, "dropview": 4, "dtype": [3, 36], "duckdb": 17, "due": [2, 7, 11, 21], "duplic": [3, 4, 5, 7, 29, 36], "dure": [7, 18, 21], "dynamic_lookup": 21, "e": [3, 4, 5, 7, 18, 31, 44], "each": [3, 4, 5, 7, 18, 20, 21, 24, 27, 33], "earli": 20, "easi": [20, 42], "easier": [20, 27, 36, 37], "easili": [4, 7, 20], "east": 35, "effect": [30, 37], "effort": 20, "either": [2, 3, 4, 7, 18, 20, 24], "electr": [24, 33], "element": [3, 4, 5, 6, 7, 26], "ellipsi": [3, 7, 18], "els": 31, "else_expr": 4, "employe": 26, "empti": [2, 4, 5, 7, 13, 24, 26], "empty_t": 2, "emptyrel": 4, "enabl": [2, 7, 20, 36], "enable_cell_expans": [6, 7, 36], "enable_url_t": 2, "encod": [5, 15], "encourag": 21, "end": [0, 3, 4, 5, 7, 13, 14, 17, 18, 33], "end_bound": [4, 7], "ends_with": 5, "engin": [2, 7, 22, 23], "enough": 18, "ensur": [6, 8], "entir": [18, 24, 31, 33], "entri": [3, 5, 24, 33], "enum": [3, 4, 7, 18], "enumer": 18, "enviorn": 21, "environ": [21, 22, 36], "equal": [3, 4, 5, 7], "equival": [5, 18, 20, 24, 33], "error": [2, 4, 6, 7, 21], "especi": 21, "essenti": [7, 14, 25], "etc": [2, 4, 6, 7, 9, 10, 18], "eval_rang": 18, "evalu": [3, 4, 5, 7, 18, 23, 24, 26, 31, 33], "evaluate_al": [7, 18, 31], "evaluate_all_with_rank": [18, 31], "even": [2, 7, 20, 29, 36], "everi": [5, 7, 18], "everyth": [9, 10], "ex": [4, 7, 30], "exact": 20, "exactli": [3, 33], "examin": [4, 7], "exampl": [2, 3, 4, 5, 6, 7, 13, 18, 20, 23, 24, 26, 27, 29, 31, 32, 33, 35, 37, 44], "excel": 20, "except": [3, 4, 5, 7, 26], "except_al": 3, "exclud": [3, 29], "execut": [2, 3, 4, 7, 18, 21, 22, 23, 34, 36, 38], "execute_stream": [3, 7, 14], "execute_stream_partit": 3, "execution_plan": 3, "executionplan": [2, 3, 7, 13], "exeggcut": 24, "exist": [2, 3, 4, 5, 6, 7, 20], "exp": [4, 5, 7], "exp_smooth": 31, "expand": [3, 6, 36], "expect": [4, 5, 7, 18, 20, 26, 31, 33], "expens": 3, "experi": 21, "explain": [3, 4], "explan": [3, 23], "explicit": 34, "explicitli": [7, 18], "expon": 5, "exponenti": [4, 5, 7], "exponentialsmooth": 31, "export": [2, 3, 20, 21, 41], "expos": [2, 20, 31, 35, 44], "expr": [2, 3, 5, 7, 11, 18, 19, 31, 33], "expr1": 5, "expr2": 5, "express": [3, 4, 5, 7, 18, 24, 27, 28, 31, 33], "exprfuncbuild": [4, 7], "extend": [5, 8, 20], "extens": [2, 4, 6, 7, 11], "extract": [4, 5, 6, 7, 27], "extraenv": 21, "f": [4, 23, 24, 26, 27, 33, 35], "f2f2f2": 36, "face": 20, "fact": [20, 31], "factori": [4, 5, 7, 18], "fail": [3, 21, 27], "fair": [2, 7], "fairi": [24, 33], "fals": [3, 4, 5, 6, 7, 18, 20, 21, 22, 26, 27, 30, 31, 34, 35, 36, 37, 44], "familiar": [21, 36], "far": 3, "faster": [5, 18], "featur": [5, 20, 21, 35, 38], "fetch": 21, "few": [20, 21, 23, 36], "ffi": 35, "ffi_": 20, "ffi_provid": 20, "ffi_tablefunct": 31, "ffi_tableprovid": [2, 20, 44], "field": [3, 5, 6, 27], "fight": [24, 33], "file": [2, 3, 7, 9, 10, 11, 15, 20, 21, 22, 23, 30, 37, 39, 40, 42, 43], "file_compression_typ": [2, 7, 11], "file_extens": [2, 7, 11], "file_partition_col": [2, 7, 11], "file_sort_ord": [2, 7, 11], "filenam": 21, "filetyp": 4, "fill": [3, 4, 5, 7, 27, 33], "fill_nan": [4, 7], "fill_nul": [3, 4, 7, 28], "filter": [3, 4, 5, 7, 13, 23, 26, 32, 33, 35, 36], "final": [23, 31], "find": [5, 20, 21, 23, 24, 33], "find_in_set": 5, "finish": [4, 24], "fire": [22, 24, 27, 35, 37], "first": [2, 3, 4, 5, 7, 20, 21, 23, 24, 26, 33, 36, 37], "first_1": 24, "first_2": 24, "first_arrai": 5, "first_valu": [5, 18, 24], "fix": 18, "flag": [5, 17, 18, 21], "flatten": [4, 5, 7], "fleur": 27, "float": [4, 5, 7, 18, 31, 36], "float64": [7, 18, 27, 31], "floor": [4, 5, 7], "flow": [7, 13], "flower": 27, "fly": [22, 24, 33, 35, 37], "fn": [31, 44], "focus": 20, "folder": [20, 31, 44], "follow": [2, 3, 4, 5, 7, 18, 20, 21, 23, 24, 26, 27, 29, 31, 33, 35, 37], "foo": 34, "footer": 6, "fora": [4, 7], "forc": 6, "foreign": 20, "foreign_provid": 20, "foreigntableprovid": 20, "form": [3, 5, 7, 13, 24], "format": [2, 3, 4, 5, 6, 7, 13, 23, 35, 39, 42], "format_argu": 5, "format_html": [6, 36], "formatt": [5, 6, 7], "formatted_valu": 6, "formatter_class": 36, "formattermanag": 6, "formatting_context": 36, "forth": 38, "found": [5, 21, 33, 44], "four": 31, "frame": [4, 5, 7, 18, 25, 31], "frame_bound": 4, "framework": 21, "free": [2, 7], "frequent": [20, 21], "from": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 15, 18, 21, 22, 23, 24, 25, 26, 27, 29, 30, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 43, 45], "from_arrai": [31, 35], "from_arrow": [2, 35, 38], "from_arrow_t": 2, "from_panda": 2, "from_polar": [2, 35], "from_proto": [7, 13], "from_pydict": [2, 25, 26, 29, 31, 32, 35, 38], "from_pylist": [2, 29, 35], "from_str": 3, "from_substrait_plan": 15, "from_unixtim": [4, 5, 7], "from_val": 5, "fuction": 18, "full": [3, 5, 28, 45], "fulli": 21, "func": [2, 3, 7, 18, 31], "function": [2, 3, 4, 12, 14, 16, 18, 19, 20, 23, 25, 28, 35, 43], "function_to_impl": [18, 31], "further": 20, "futher": 5, "futur": [18, 33], "g": [5, 18], "gamma": 35, "gcd": 5, "gener": [4, 7, 13, 14, 15, 18, 19, 20, 21, 22, 35, 37], "geodud": 33, "get": [3, 6, 7, 13, 18, 21, 26, 35, 36], "get_cell_styl": 6, "get_default_level": 3, "get_formatt": [6, 36], "get_frame_unit": [4, 7], "get_header_styl": 6, "get_lower_bound": [4, 7], "get_offset": 4, "get_rang": 18, "get_table_styl": 36, "get_upper_bound": [4, 7], "get_value_styl": 36, "getenv": 35, "ghost": 24, "gil": 22, "git": 21, "github": [4, 5, 7, 21], "give": [5, 24, 30, 37], "given": [0, 2, 4, 5, 6, 7, 18, 31], "glanc": 20, "global": [2, 6, 7, 11, 36], "global_ctx": 2, "go": [20, 25, 27], "goe": 20, "gold": 5, "good": [20, 21], "googlecloud": [12, 35], "graph": [7, 13], "graphic": [7, 13], "graphviz": [7, 13], "grass": [22, 24, 27, 33, 35, 37], "great": 21, "greater": [4, 5, 7], "greatest": 5, "greatli": 31, "greedi": [2, 7], "green": 26, "grimer": 33, "ground": 24, "group": [2, 3, 4, 5, 7, 11, 18, 23, 24, 25, 33], "group_bi": [3, 24], "groupingset": 4, "guarante": 20, "guid": [2, 28, 34, 37], "gzip": 3, "ha": [2, 3, 5, 6, 7, 18, 20, 26, 30, 35], "handl": [6, 14, 24, 28, 33], "happen": [21, 36, 38], "has_head": [2, 7, 11], "has_mor": [6, 36], "hash": [3, 4, 5, 7], "haskel": 25, "have": [2, 3, 5, 6, 7, 11, 15, 18, 20, 21, 22, 24, 29, 31, 33, 44], "head": 3, "header": [2, 3, 6, 7, 11], "healthi": 21, "heavy_red_unit": 26, "height": [6, 36], "help": [2, 6, 7, 11, 21, 26, 27, 36], "helper": [7, 18], "henc": 18, "here": [5, 20, 27, 30, 31, 33, 36, 37, 38, 45], "hex": 5, "hexadecim": [4, 5, 7], "high": [4, 7], "higher": [3, 4, 7], "highli": 31, "highlight": 37, "hint": [2, 21], "homebrew": 21, "host": 2, "how": [2, 3, 4, 5, 7, 18, 20, 24, 25, 28, 29, 31, 33, 34, 36, 37], "howev": [18, 31], "hp": [22, 35, 37], "html": [2, 5, 6, 7, 17], "html_formatt": [7, 19, 36], "http": [2, 4, 5, 7, 12, 13, 15, 17, 35], "hyperbol": [4, 5, 7], "i": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 14, 17, 18, 20, 21, 22, 23, 24, 26, 27, 29, 31, 33, 35, 36, 37, 38, 39, 40, 42, 43], "ic": 24, "id": [2, 6, 21, 29], "ideal": 20, "ident": 35, "identifi": [2, 4, 7, 20, 30], "idx": [18, 31], "ignor": [5, 21, 24, 33], "ignore_nul": [24, 33], "ilik": 4, "immut": [7, 18, 31], "impl": [31, 44], "implement": [2, 3, 6, 18, 21, 31, 35, 36, 38, 44], "import": [2, 4, 6, 7, 18, 20, 22, 23, 24, 25, 26, 27, 29, 30, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 43, 45], "improv": [2, 7, 18, 31, 36], "in_list": [5, 27], "includ": [2, 3, 4, 6, 7, 20, 23, 24, 27, 29, 36], "include_rank": [18, 31], "inclus": [2, 4, 5, 7], "incorpor": 31, "increas": [2, 6, 7, 24], "increment": [18, 20, 31], "indent": [7, 13], "independ": [5, 33], "index": [4, 5, 6, 7, 17, 18, 26], "indic": [4, 5, 6, 7, 26], "individu": [26, 33], "infer": [2, 7, 11], "inform": [2, 3, 4, 7, 8, 15, 17, 20, 31], "information_schema": [2, 7], "init": 21, "initcap": [4, 5, 7], "initi": [4, 5, 6, 7], "inlin": 18, "inlist": 4, "inner": [3, 28], "input": [2, 3, 4, 5, 7, 11, 13, 18, 19, 26, 31], "input_item": [8, 9, 10], "input_typ": [7, 18], "inputsourc": 8, "insert": [2, 7], "instanc": [2, 5, 6, 7, 18, 23], "instanti": [7, 18], "instead": [4, 5, 7, 20], "insubqueri": 4, "int": [2, 3, 4, 5, 6, 7, 11, 13, 18, 31], "int32": [7, 18, 27], "int64": [7, 18, 25, 27, 31], "integ": [4, 5, 6, 7, 26], "integr": [20, 37, 44], "intend": [6, 20], "interact": [6, 20, 26], "intercept": 5, "interchang": 42, "interest": 26, "interfac": [2, 5, 20, 22, 23, 31, 33, 35, 36, 38, 44], "intermedi": [7, 18], "intern": 31, "intersect": [3, 5], "interv": 5, "into_view": 3, "intro": 21, "introduc": [21, 23], "intuit": 20, "invalid": [6, 7], "invers": [4, 5, 7], "invoc": 18, "io": [2, 7, 15, 19], "is_caus": 18, "is_correct_input": [8, 9, 10], "is_current_row": 4, "is_empti": 26, "is_follow": 4, "is_not_nul": [4, 7, 24], "is_nul": [4, 7, 31], "is_null_arr": 31, "is_preced": 4, "is_styles_load": 6, "is_unbound": 4, "isfals": 4, "isnan": [4, 5, 7], "isnotfals": 4, "isnotnul": [4, 7], "isnottru": 4, "isnotunknown": 4, "isnul": 4, "issu": [5, 6, 21, 33], "istru": 4, "isunknown": 4, "iszero": [4, 5, 7], "iter": [3, 7, 14], "iterat": 3, "its": [3, 5, 7, 13, 18, 20, 22, 33], "itself": 26, "ivi": 27, "ivyfleur": 27, "ivysaur": [22, 27, 33, 35, 37], "java": 25, "javascript": [6, 36, 42], "jigglypuff": 33, "join": [2, 3, 4, 7, 13, 28], "join_kei": [3, 29], "join_on": 3, "joinconstraint": 4, "jointyp": 4, "json": [2, 3, 7, 11, 35, 41], "jupyt": [6, 36, 37], "jupyterlab": 37, "just": 36, "jynx": 24, "kakuna": [22, 33, 35, 37], "keep": [21, 32], "kei": [2, 3, 4, 6, 7, 20, 23, 26, 29], "kept": 3, "kind": [0, 7, 20, 21], "know": [2, 7], "known": 26, "kwarg": [6, 7, 8, 9, 10], "kwd": [3, 18], "l179": [4, 7], "lab": 37, "label": 3, "lack": 22, "lag": [5, 18, 33], "lambda": [7, 18], "languag": [2, 7, 13, 20], "larg": [3, 27], "large_trip_dist": 30, "last": [4, 5, 7, 33], "last_valu": [5, 24, 33], "last_with_nul": 33, "last_wo_nul": 33, "later": [35, 37, 44], "latest": [5, 17, 20], "latter": 2, "lazi": 23, "lcm": 5, "lead": [5, 18, 20, 31, 33, 35], "leaf": [7, 13], "leak": 22, "learn": [20, 25, 33], "least": [5, 18, 24, 29, 31, 36], "leav": [7, 13], "left": [3, 5, 27, 28, 36], "left_on": [3, 29], "leftmost": 5, "legendari": [22, 35, 37], "len": [18, 27], "length": [4, 5, 6, 7, 18], "less": [4, 5, 7], "lesson": 20, "let": [20, 31, 34, 44], "letter": [4, 5, 7, 30], "level": [3, 5, 20], "levenshtein": 5, "leverag": 20, "lib": 21, "lib_dir": 21, "lib_nam": 21, "librari": [7, 8, 20, 22, 36, 37, 38, 44], "lightweight": 42, "like": [2, 4, 5, 6, 7, 8, 20, 21, 22, 27, 36], "limit": [3, 4, 5, 21, 23, 25, 27], "line": [2, 3, 7, 11, 13, 20], "linear": [5, 24], "link": [21, 33], "lint": 21, "linter": 21, "list": [0, 2, 3, 4, 5, 6, 7, 11, 13, 18, 24, 31, 32, 33, 35], "list_append": [5, 21], "list_cat": 5, "list_concat": 5, "list_dim": [4, 5, 7], "list_distinct": [4, 5, 7], "list_el": 5, "list_except": 5, "list_extract": 5, "list_indexof": 5, "list_intersect": 5, "list_join": 5, "list_length": [4, 5, 7], "list_ndim": [4, 5, 7], "list_posit": 5, "list_prepend": 5, "list_push_back": 5, "list_push_front": 5, "list_remov": 5, "list_remove_al": 5, "list_remove_n": 5, "list_repeat": 5, "list_replac": 5, "list_replace_al": 5, "list_replace_n": 5, "list_res": 5, "list_slic": 5, "list_sort": 5, "list_to_str": 5, "list_union": 5, "listingt": 2, "lit": [3, 4, 5, 7, 21, 23, 24, 26, 30, 33, 36, 38], "liter": [3, 4, 7, 27, 28, 30, 31, 32], "ll": [27, 29, 33], "ln": [4, 5, 7], "load": 6, "local": [2, 20, 21], "localfilesystem": [12, 35], "locat": [2, 9, 19], "locationinputplugin": [9, 10], "lock": 22, "log": [5, 27], "log10": [4, 5, 7], "log2": [4, 5, 7], "logarithm": [4, 5, 7], "logic": [2, 3, 4, 7, 13, 15, 17, 23, 24, 30, 36], "logical_plan": [3, 15], "logicalplan": [2, 3, 4, 7, 13, 15, 17], "lonely_trip": 30, "long": [6, 20], "long_tim": 26, "longer": 5, "look": [21, 34], "low": [4, 7, 24], "low_passenger_count": 30, "lower": [4, 5, 7, 18, 27, 30], "lowercas": [3, 4, 5, 7], "lowest": [20, 24], "lpad": 5, "ltrim": [4, 5, 7], "lz4": 3, "lz4_raw": 3, "lzo": 3, "m": 21, "mac": 21, "machin": 21, "machop": 33, "made": 30, "magikarp": 24, "magnemit": 33, "mai": [2, 3, 5, 7, 11, 18, 20, 31, 35, 37, 38], "main": [2, 23], "maintain": [2, 3, 20, 23], "major": [21, 22], "make": [5, 20, 21, 22, 27, 36], "make_arrai": 5, "make_d": 5, "make_list": 5, "manag": [2, 6, 7, 21], "mani": [20, 24, 31, 36], "manipul": [2, 7, 27, 36], "mankei": 33, "manner": 20, "manual": 21, "map": 3, "map_err": 44, "match": [3, 4, 5, 27, 29], "math": 24, "mathemat": [28, 30], "maturin": 21, "max": [5, 24, 25], "max_cell_length": [6, 7, 36], "max_height": [6, 7, 36], "max_memory_byt": [6, 36], "max_row": 36, "max_width": [6, 7, 36], "maximum": [2, 5, 6, 7, 11, 36], "md5": [4, 5, 7], "mean": [5, 20, 21, 25], "meaning": [5, 30], "meant": [7, 13], "medal": 5, "median": [5, 24, 25], "member": 21, "memoiz": 18, "memori": [2, 3, 6, 7, 13, 18, 22], "mention": 26, "merg": [7, 18, 29, 31], "messag": [6, 36], "metadata": [2, 4, 5, 7, 11], "metapod": [22, 24, 33, 35, 37], "method": [2, 3, 5, 6, 7, 18, 23, 25, 27, 29, 31, 32, 36], "metric": 3, "metrorid": 29, "microsecond": 5, "microsoftazur": [12, 35], "might": [6, 18, 24], "millisecond": 5, "min": [5, 24, 25], "min_rows_displai": [6, 36], "minimum": [2, 5, 6, 7, 36], "miss": [3, 28], "model": 3, "modifi": [3, 23], "modify_df": 3, "modul": [16, 33], "modulo": [4, 7], "moment": [3, 20], "month": [5, 27], "more": [2, 3, 4, 6, 7, 15, 20, 21, 23, 24, 27, 31, 34], "most": [18, 20, 26, 33, 37], "mostli": 21, "much": [18, 21, 36], "multi": 22, "multipl": [2, 3, 4, 5, 6, 7, 18, 24, 27, 29, 31, 33, 35, 36], "must": [2, 3, 4, 5, 7, 18, 24, 26, 30, 31, 33, 38, 44], "my": 36, "my_capsul": 20, "my_delta_t": 35, "my_provid": 20, "my_tabl": [32, 36, 44], "my_udaf": 31, "myaccumul": 31, "myformatt": 36, "mysql": 17, "mystyleprovid": 36, "mytablefunct": 31, "mytableprovid": [20, 44], "myusernam": 21, "n": [3, 5], "name": [0, 2, 3, 4, 5, 6, 7, 11, 18, 20, 22, 23, 24, 25, 26, 27, 29, 30, 31, 33, 35, 36, 37, 44], "name_pair": 5, "named_expr": 3, "named_struct": [5, 21], "nan": [4, 5, 7], "nanosecond": 5, "nanvl": 5, "narrowli": 20, "nativ": 20, "natur": [4, 5, 7], "nearest": [4, 5, 7], "necessari": 20, "need": [2, 3, 4, 6, 7, 11, 18, 20, 21, 31, 33, 36, 37], "neg": [4, 5], "negat": [4, 5, 7, 27], "new": [2, 3, 4, 5, 6, 7, 17, 18, 20, 21, 26, 28, 31, 44, 45], "new_bound": [20, 44], "new_err": 44, "new_nam": 3, "next": [5, 6, 7, 14], "node": [7, 13], "non": [3, 4, 5, 24, 33], "none": [2, 3, 4, 5, 6, 7, 11, 15, 18, 20, 31, 33, 35, 36], "normal": 24, "not_red_unit": 26, "notat": [26, 42], "note": [2, 3, 4, 7, 23, 26, 38], "notebook": [6, 36, 37], "now": [5, 18, 27, 32], "nr": 25, "nth": 36, "nth_valu": [5, 18, 24], "ntile": [5, 33], "null": [3, 4, 5, 7, 25, 27, 29, 31, 38], "null_count": 25, "null_first": 5, "null_treat": [4, 5, 7, 24, 33], "nullabl": 3, "nullif": [5, 27], "nulls_first": [4, 5, 7], "nulltreat": [4, 5, 7, 24, 33], "num": [3, 5], "num_centroid": 5, "num_el": 26, "num_row": [7, 18, 31], "number": [2, 3, 4, 5, 6, 7, 11, 13, 18, 21, 26, 27, 31, 33, 36], "numebr": 5, "numer": [3, 4, 5, 7], "nvl": 5, "o": 35, "object": [2, 3, 4, 6, 7, 12, 20, 26, 31, 34, 38, 42], "object_stor": [7, 19, 35], "objectstor": 2, "obtain": [8, 22], "obviou": 20, "occur": [7, 18, 38], "occurr": 5, "octet_length": [4, 5, 7], "oddish": 33, "offend": 21, "offer": [27, 36, 45], "offici": 20, "offset": [3, 4], "often": 33, "old": 3, "old_nam": 3, "older": 35, "olymp": 5, "omit": 29, "on_expr": 3, "onc": [5, 6, 8, 18, 31, 36, 44], "one": [3, 4, 5, 7, 18, 20, 24, 29, 31, 33, 35], "onli": [2, 3, 4, 5, 6, 7, 11, 18, 20, 24, 27, 29, 31, 33, 36], "onlin": [2, 3, 4, 5, 7, 20, 34], "op": [3, 4, 7], "open": 6, "oper": [2, 3, 4, 5, 7, 13, 14, 18, 20, 22, 24, 26, 30, 31, 33, 35, 36, 38], "operand": [4, 7], "operatefunctionarg": 4, "opt": 21, "optim": [3, 18, 20], "optimized_logical_plan": 3, "option": [2, 3, 4, 5, 6, 7, 11, 18, 21, 23, 24, 27, 34, 35, 37], "options_intern": [2, 7], "order": [2, 3, 4, 5, 7, 8, 11, 18, 20, 26], "order_bi": [4, 5, 7, 24, 33], "org": [2, 5, 7, 13], "origin": [3, 5, 31], "other": [2, 3, 4, 5, 6, 7, 18, 20, 21, 22, 23, 26, 28, 31, 36], "otherwis": [4, 5, 6, 7], "our": [20, 21, 24, 37], "out": [3, 5, 20, 24, 25, 26, 27, 29, 30, 33, 37, 38, 45], "output": [3, 4, 6, 7, 13, 18, 21, 24, 26, 31, 32, 36], "over": [3, 4, 7, 18, 20, 22, 24, 33, 36], "overhead": 18, "overlai": 5, "overlap": 5, "overrid": 31, "overridden": 24, "own": [8, 31], "pa": [2, 4, 7, 14, 18, 31, 35, 38], "packag": [5, 20, 21], "pad": [5, 36], "page": [19, 20, 31], "pair": 5, "panda": [2, 3, 23, 25, 35, 36, 45], "pandas_df": 35, "para": 33, "parallel": [2, 7], "param_nam": 6, "paramet": [2, 3, 4, 5, 6, 7, 11, 15, 18, 21, 26, 28, 29, 36], "parasect": 33, "parquet": [2, 3, 7, 11, 20, 22, 23, 30, 34, 35, 41], "parquet_prun": [2, 7, 11], "part": [5, 27], "particular": 5, "partit": [2, 3, 4, 5, 7, 11, 13, 18, 24], "partition_bi": [4, 5, 7, 33], "partition_count": [7, 13], "pass": [3, 7, 18, 20, 21, 25, 26, 31, 34, 35], "passenger_count": 30, "path": [2, 3, 7, 11, 15, 21, 35, 36], "path_to_t": 35, "pathlib": [2, 3, 7, 11, 15], "pattern": [5, 20], "pc": [7, 18], "pcre": 5, "pd": 35, "peopl": 5, "per": [3, 6, 18, 33, 36], "percent": 5, "percent_rank": [5, 18, 33], "percentag": 5, "percentil": 5, "perform": [2, 3, 4, 5, 7, 18, 20, 21, 23, 24, 27, 31, 33, 35], "period": 20, "person": 21, "physic": [3, 7, 13, 23], "pi": 5, "pick": 5, "pinsir": 33, "pip": [22, 37], "pixel": [6, 36], "pl": 35, "place": [5, 21, 37], "placehold": 4, "plain": 36, "plan": [2, 3, 4, 7, 15, 17, 18, 19, 22, 23, 36], "plan_intern": 15, "plan_to_sql": 17, "planner": [7, 13], "pleas": 30, "plu": 5, "plugin": [8, 9, 10], "point": [4, 5, 6, 7, 21], "pointer_width": 21, "poison": [22, 24, 33, 35, 37], "pokemon": [22, 24, 27, 33, 35, 37, 45], "polar": [2, 3, 35], "polars_df": 35, "pool": [2, 7], "popul": 5, "popular": [27, 35], "portion": 20, "posit": [5, 6, 24], "possibl": [3, 4, 7, 18, 20, 27, 31, 33], "post": 21, "postgr": 17, "postgresql": 17, "potenti": [3, 7, 13], "pow": [5, 27], "power": [5, 27, 31, 33, 36], "pr": 21, "practic": 20, "prece": 5, "preced": [4, 7, 18], "preceed": 33, "precis": 5, "predic": [2, 3, 7, 11], "prefer": 21, "prefix": [5, 20], "prepar": 4, "prepend": 5, "presenc": 27, "present": 29, "preserve_nul": 3, "pretti": 17, "prevent": [21, 36], "previou": [5, 31, 33], "previous": 2, "primari": [9, 26], "primarili": 6, "print": [3, 7, 13, 32, 34, 36], "printabl": [7, 13, 18], "prior": [3, 35], "probabl": 24, "process": [18, 24, 33], "produc": [5, 7, 13, 15, 18, 20, 33], "product": 5, "program": 20, "programmat": [7, 13], "project": [3, 4, 7, 13, 20, 21, 36, 38], "properti": [0, 4, 7, 13], "proto_byt": 15, "protobuf": [7, 13], "protocol": [2, 6], "provid": [0, 2, 3, 4, 5, 6, 7, 8, 9, 14, 15, 17, 18, 20, 23, 24, 27, 31, 33, 37, 41], "prune": [2, 7, 11], "psychic": 24, "public": [0, 7], "pull": 21, "pure": 21, "push": [21, 35], "pushdown_filt": 34, "put": 30, "py": [2, 3, 7, 15, 20, 31, 44], "pyarrow": [0, 2, 3, 4, 7, 11, 14, 18, 20, 25, 31, 35, 38, 45], "pycapsul": [2, 3, 20, 31, 35, 38, 44], "pycapsuleinterfac": 2, "pymethod": [31, 44], "pyo3": [20, 21, 31], "pyo3_build_config": 21, "pyo3_config_fil": 21, "pyo3_print_config": 21, "pyobject": [4, 7], "pypi": 37, "pyproject": 21, "pyresult": [31, 44], "pyruntimeerror": 44, "pyspark": 22, "pytabl": 20, "pytest": 21, "python": [2, 4, 7, 18, 25, 26, 31, 35, 37, 38, 44], "python3": 21, "python_valu": [4, 7], "pythontyp": [4, 7], "queri": [2, 7, 13, 15, 18, 20, 22, 23, 27, 32, 36], "quick": 25, "quit": 43, "quot": 30, "r": [3, 4, 5, 7, 17, 20, 21], "radian": [4, 5, 7], "rais": [3, 5, 6, 7], "random": [5, 18, 25, 26], "rang": [2, 3, 4, 5, 7, 18, 25, 26, 27, 31, 33, 34], "rank": [5, 18, 31, 33], "ranks_in_partit": 18, "rather": [5, 15], "ratio": 5, "raw": [4, 6], "raw_sort": 4, "rawexpr": [4, 7], "rb": [7, 14], "re": 20, "read": [2, 7, 9, 10, 11, 15, 20, 34, 35, 37, 39, 40, 42, 43, 45], "read_avro": [2, 7, 11, 39], "read_csv": [2, 7, 11, 22, 23, 24, 33, 35, 37, 40], "read_json": [2, 7, 11, 42], "read_parquet": [2, 7, 11, 23, 30, 43], "read_tabl": 2, "reader": [2, 7, 11, 38], "realiti": 24, "reason": 21, "rebuild": 21, "receiv": [5, 18, 20], "recent": [33, 35], "recommend": [3, 20, 21, 31], "record": [2, 3, 6, 7, 13, 14, 23, 30, 31, 35, 38, 39], "record_batch": [2, 3, 7, 19], "record_batch_stream": [7, 14], "recordbatch": [2, 3, 6, 7, 14, 31, 35], "recordbatchstream": [2, 3, 7, 14], "recursivequeri": 4, "red": [26, 36], "red_or_green_unit": 26, "red_unit": 26, "reduc": [21, 31, 36], "ref": [5, 31], "refer": [3, 5, 6, 20, 23, 27, 45], "referenc": [2, 23], "reflect": 6, "refresh": 6, "regardless": 18, "regener": 21, "regex": 5, "regexp_count": 5, "regexp_lik": 5, "regexp_match": [5, 27], "regexp_replac": [5, 27], "region": 35, "regist": [2, 6, 7, 8, 11, 20, 23, 28, 31, 35, 36, 44, 45], "register_avro": 2, "register_csv": [2, 27, 36, 40, 45], "register_dataset": [2, 35], "register_formatt": 6, "register_json": 2, "register_listing_t": 2, "register_object_stor": [2, 35], "register_parquet": [2, 35, 43], "register_record_batch": 2, "register_t": [2, 3], "register_table_provid": [2, 35, 44], "register_udaf": 2, "register_udf": 2, "register_udtf": [2, 31], "register_udwf": 2, "register_view": [2, 32], "regr_avgi": [5, 24], "regr_avgx": [5, 24], "regr_count": [5, 24], "regr_intercept": [5, 24], "regr_r2": [5, 24], "regr_slop": [5, 24], "regr_sxi": 5, "regr_sxx": [5, 24], "regr_syi": [5, 24], "regress": [5, 24], "regular": [5, 6, 27], "rel": [5, 33], "relat": [6, 7, 13, 29], "releas": [20, 33], "relev": 21, "reli": 21, "reload": 6, "remain": [4, 5, 7, 27], "remot": [9, 10], "remov": [2, 3, 4, 5, 7, 24], "renam": 3, "renamed_ag": 26, "render": 6, "repartit": [2, 3, 4, 7], "repartition_by_hash": 3, "repeat": [5, 26], "repeated_arrai": 26, "replac": [3, 5, 27], "repo": 21, "report": [3, 21], "repositori": [20, 31, 35], "repr": 6, "repr_row": [6, 36], "repres": [2, 3, 4, 5, 7, 11, 13, 14, 15, 23, 26, 31, 36], "represent": [2, 3, 4, 5, 6, 7, 11, 13, 18], "request": [3, 21], "requested_schema": [2, 3], "requir": [3, 4, 18, 20, 27, 35], "reserv": [2, 7], "reset": [6, 36], "reset_formatt": [6, 36], "reset_styles_loaded_st": 6, "resolv": [21, 33], "resourc": 20, "respect": [3, 5, 24, 35], "respect_nul": [5, 24, 33], "result": [2, 3, 5, 7, 13, 14, 18, 22, 23, 24, 26, 29, 30, 31, 32, 33, 36], "result_dict": 32, "retriev": [2, 4, 7, 29], "return": [0, 2, 3, 6, 8, 9, 10, 11, 13, 15, 18, 26, 29, 31, 36, 38], "return_typ": [7, 18], "reus": 20, "reusabl": 4, "revers": [4, 5, 7], "review": [20, 21], "rex": [4, 7], "rex_call_oper": [4, 7], "rex_call_operand": [4, 7], "rex_typ": [4, 7], "rextyp": [4, 7], "rfc3339": [4, 5, 7], "rh": [4, 7], "rhyhorn": 33, "rich": 6, "richer": 36, "right": [3, 5, 29], "right_on": [3, 29], "ritchi": 33, "robin": 3, "rock": 24, "roll": 33, "root": [4, 5, 7, 13], "roption": 20, "round": [3, 5, 23], "rout": 20, "row": [2, 3, 4, 5, 6, 7, 11, 18, 23, 24, 25, 26, 29, 31, 32, 33, 36, 45], "row_count": 6, "row_idx": 6, "row_numb": [5, 18, 33], "rpad": 5, "rresult": 20, "rstring": 20, "rtrim": [4, 5, 7], "rubi": 25, "run": [2, 3, 7, 11, 22, 32, 37], "runnabl": 21, "runtim": [2, 7, 18, 34], "runtimeconfig": 2, "runtimeenvbuild": [2, 7, 34], "rust": [5, 20, 22, 31, 34, 35, 36, 44], "rustc": 20, "rustflag": 21, "rustonomicon": 20, "rvec": 20, "s3": 35, "safe": 20, "safeti": 22, "same": [3, 5, 7, 18, 20, 23, 31], "sampl": [5, 25, 32], "saur": 27, "save": 18, "scalar": [4, 7, 18, 26, 28], "scalarsubqueri": 4, "scalarudf": [2, 7, 18], "scalarvalu": 18, "scalarvari": 4, "scan": [2, 7, 13], "schema": [0, 2, 3, 4, 6, 7, 11, 13, 25, 36], "schema_infer_max_record": [2, 7, 11], "schema_nam": [4, 7], "scheme": 3, "scienc": 27, "score": 5, "script": 6, "search": 5, "second": [5, 23, 24, 26], "second_arrai": 5, "secret_access_kei": 35, "section": [20, 23, 25, 28, 29, 33, 35], "see": [2, 3, 4, 5, 7, 14, 15, 17, 18, 20, 21, 23, 24, 26, 31, 33], "seen": [18, 24], "select": [2, 3, 4, 5, 7, 11, 18, 23, 26, 27, 28, 31, 32, 33, 36, 38, 45], "select_column": 3, "self": [7, 14, 18, 31, 36, 44], "semi": [3, 28], "sensit": 3, "separ": 5, "seper": 5, "sequenc": 3, "serd": 15, "seri": 26, "serial": [15, 39], "serialize_byt": 15, "serialize_to_plan": 15, "serv": 20, "session": [2, 6, 7, 31, 34, 36, 37], "session_id": 2, "sessionconfig": [2, 7, 34], "sessioncontext": [2, 3, 5, 7, 8, 13, 15, 20, 22, 23, 24, 25, 26, 27, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 42, 43, 44, 45], "sessioncontextintern": 2, "set": [0, 2, 4, 5, 6, 7, 17, 18, 20, 21, 23, 28, 31, 34, 36], "set_custom_cell_build": 6, "set_custom_header_build": 6, "set_formatt": 6, "setvari": 4, "sever": 30, "sha": [4, 5, 7], "sha224": [4, 5, 7], "sha256": [4, 5, 7], "sha384": [4, 5, 7], "sha512": [4, 5, 7], "sharabl": 20, "share": [6, 20, 21, 23, 26, 38], "shift_offet": 5, "shift_offset": 5, "shot": 18, "should": [2, 4, 5, 7, 8, 11, 13, 15, 21, 24, 29, 31, 33], "show": [3, 6, 20, 22, 23, 25, 26, 29, 31, 33, 35, 36, 37, 44], "show_truncation_messag": [6, 36], "shown": 6, "side": [4, 5, 7, 20], "sign": [4, 5, 7], "signific": 35, "significantli": 5, "signum": [4, 5, 7], "silver": 5, "similar": [5, 20, 23, 26, 33, 36], "similarto": 4, "simpl": [5, 21, 30, 42, 43], "simplest": [18, 31], "simpli": [3, 7, 18, 20, 21], "simplifi": 33, "sin": [4, 5, 7], "sinc": [3, 24, 31, 35], "sine": [4, 5, 7], "singl": [2, 3, 4, 5, 7, 13, 18, 24, 26, 31, 33], "sinh": [4, 5, 7], "size": [2, 3, 5, 7, 26, 36], "skip": [2, 3, 7, 11, 18], "skip_metadata": [2, 7, 11], "slice": 5, "slightli": 31, "slope": 5, "slow": 3, "slower": 3, "slowest": 31, "slowpok": 33, "small": 35, "smallest": [18, 24], "smooth_a": 31, "snappi": 3, "snorlax": 33, "so": [2, 3, 7, 20, 21, 30, 31, 33, 38, 44], "softwar": [7, 13, 20], "solid": 36, "some": [5, 18, 20, 21, 24, 27, 31, 33, 37, 44], "sometim": [2, 7, 20, 35], "soon": [5, 35], "sort": [2, 3, 4, 5, 7, 11, 24, 33], "sortexpr": [2, 3, 4, 5, 7], "sound": 20, "sourc": [2, 5, 7, 8, 9, 10, 11, 20, 21, 23, 36, 37, 38, 44], "sp": [22, 35, 37], "space": [4, 5, 7], "sparingli": 31, "special": [6, 18], "specif": [3, 4, 6, 7, 13, 25, 26, 27, 33, 36], "specifi": [2, 3, 4, 5, 7, 26, 27, 29, 31, 33], "speed": [3, 22, 24, 33, 35, 37], "sphinx": 19, "spill": [2, 7], "spillabl": [2, 7], "split": [5, 31], "split_part": 5, "sql": [2, 7, 13, 15, 17, 18, 22, 23, 26, 30, 32, 36], "sql_with_opt": 2, "sqlite": 17, "sqloption": [2, 7], "sqltabl": [8, 9, 10], "sqltype": [4, 7], "sqrt": [4, 5, 7], "squar": [4, 5, 7], "squi": 27, "squirtl": [22, 27, 33, 35, 37], "src": [4, 7, 21], "stabl": [18, 20, 31], "standard": [5, 20], "start": [4, 5, 7, 18, 26, 30, 33, 37], "start_ag": 26, "start_bound": [4, 7], "started_young": 26, "starts_with": 5, "state": [2, 6, 7, 18, 23, 31], "state_typ": [7, 18], "statement": [2, 4, 5, 7, 23, 45], "static": [4, 7, 13, 15, 17, 18], "statist": [3, 24, 25], "std": 25, "stddev": [5, 24], "stddev_pop": [5, 24], "stddev_samp": 5, "steel": 24, "step": [5, 20], "still": [31, 35], "stop": 5, "storag": 35, "store": [2, 4, 7, 12], "str": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 15, 17, 18], "str_lit": 27, "straightforward": [39, 40], "stream": [2, 3, 7, 14, 20], "strftime": 5, "stride": 5, "string": [3, 4, 5, 6, 7, 13, 17, 18, 20, 21, 24, 25, 26, 28], "string1": 5, "string2": 5, "string_agg": [5, 24], "string_list": 5, "string_liter": [4, 7, 27], "string_view": [4, 7, 38], "strong": 22, "strpo": 5, "struct": [2, 4, 5, 7, 20, 28, 38], "structarrai": 38, "structur": [7, 13, 20], "style": [6, 20, 26], "style_provid": [6, 36], "styleprovid": [6, 36], "sub": [4, 7], "subfield": [4, 5, 7], "submit": 21, "submodul": 21, "subqueri": 4, "subqueryalia": 4, "subset": [3, 27, 30], "substr": 5, "substr_index": 5, "substrait": [7, 19], "subtract": [4, 7], "suffici": [2, 7], "suffix": 5, "suggest": 35, "sum": [5, 7, 18, 24, 31], "sum_bias_10": [7, 18], "summar": [3, 7, 18], "summari": [3, 24, 25], "support": [3, 4, 5, 6, 7, 13, 15, 17, 20, 29, 31, 35, 36], "supports_bounded_execut": [18, 31], "suppos": [5, 20, 24], "suppress_build_script_link_lin": 21, "sure": 21, "switch": 6, "symbol": 3, "sync": 21, "synchon": 20, "syntax": 5, "system": [2, 7, 20, 21], "t": [5, 18, 30], "t1": 18, "tabl": [0, 2, 3, 6, 7, 8, 9, 10, 11, 13, 18, 20, 23, 25, 27, 28, 29, 36, 37, 38, 40, 41, 43], "table_exist": 2, "table_id": 6, "table_nam": [8, 9, 10], "table_partition_col": [2, 7, 11], "table_provid": 2, "table_uuid": [6, 36], "tablefunct": [2, 7, 18], "tableprovid": [20, 44], "tableproviderexport": 2, "tablescan": 4, "tag": 6, "tail": 3, "take": [3, 6, 18, 20, 21, 24, 26, 31, 33], "tan": [4, 5, 7], "tangent": [4, 5, 7], "tanh": [4, 5, 7], "target": [2, 7], "target_partit": [2, 7], "task": [27, 38], "taxi": 23, "td": 36, "technic": 22, "tempor": 28, "temporari": [2, 7, 36], "temporarili": 36, "term": 33, "termin": 36, "terminologi": 20, "test": [5, 21], "text": [2, 5, 36], "textual": 27, "th": [5, 36], "than": [3, 4, 5, 7, 24, 31, 36], "thei": [8, 18, 20, 26, 31], "them": [5, 20, 21, 23, 25], "theme": 36, "then_expr": 4, "therefor": 3, "thi": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 14, 15, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 31, 32, 33, 35, 36, 37, 38, 44], "third": 23, "thoroughli": 20, "those": [3, 4, 7, 22, 24, 31, 35], "though": 31, "thread": 22, "three": [31, 33, 35], "through": [6, 20, 22, 28, 35, 36, 37], "thu": 18, "thusli": 20, "ticket": 21, "tie": 5, "tight": 20, "tile": 5, "time": [5, 18, 20, 21, 24, 26, 27, 31, 38], "time64": 5, "timestamp": [4, 5, 7, 27], "tip_amount": [23, 30], "tip_perc": 23, "tips_plus_tol": 30, "tlc": [23, 30], "tmp": [2, 7], "to_arrow_t": 3, "to_hex": [4, 5, 7], "to_panda": [3, 25, 27, 45], "to_polar": 3, "to_proto": [7, 13], "to_pyarrow": [7, 14], "to_pyarrow_dataset": 35, "to_pydict": [3, 32], "to_pylist": 3, "to_str": 44, "to_substrait_plan": 15, "to_timestamp": [5, 27], "to_timestamp_micro": 5, "to_timestamp_milli": 5, "to_timestamp_nano": 5, "to_timestamp_second": 5, "to_unixtim": 5, "to_val": 5, "to_vari": [4, 7, 13], "togeth": [3, 5, 24], "tolls_amount": 30, "toml": 21, "top": 25, "topic": 35, "total": [3, 4, 5, 7, 22, 23, 26, 27, 35, 37], "total_amount": 23, "total_as_float": 27, "total_as_int": 27, "toward": 5, "tr": 36, "tracker": 5, "tradit": 21, "trait": [18, 20], "transact": [2, 7], "transactionaccessmod": 4, "transactionconclus": 4, "transactionend": 4, "transactionisolationlevel": 4, "transactionstart": 4, "transfer": 20, "transform": [3, 7, 13, 23], "translat": [5, 20], "treat": [4, 33], "treatment": [4, 7], "tree": [7, 13, 26], "trigger": 3, "trim": [4, 5, 7], "trip": [23, 30, 35], "trip_dist": [23, 30], "trivial": [3, 21], "tru": 3, "true": [2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 18, 21, 24, 26, 27, 30, 31, 33, 34, 36], "trunc": 5, "truncat": [5, 6, 24, 27, 30, 33, 36], "try": [2, 7, 11, 20], "trycast": 4, "tupl": [2, 3, 5, 7, 11, 18], "turn": [3, 4, 7, 20], "tutori": 37, "two": [3, 4, 5, 7, 13, 20, 24, 26, 29, 31, 33, 34], "type": [2, 3, 4, 5, 6, 7, 11, 18, 20, 21, 22, 24, 26, 27, 30, 31, 33, 35, 37], "type_class": 6, "typeerror": 6, "typic": [0, 4, 7, 14, 17, 18, 23], "typing_extens": [7, 14], "u": [20, 24, 26, 35], "udaf": [2, 7, 18, 22, 31], "udaf1": [7, 18], "udaf2": [7, 18], "udaf3": [7, 18], "udf": [2, 7, 18, 19, 22, 31], "udf4": [7, 18], "udtf": [7, 18], "udwf": [2, 7, 18], "udwf1": [7, 18], "udwf2": [7, 18], "udwf3": [7, 18], "ui": 6, "ultim": 21, "unari": [7, 13], "unbound": [2, 4, 7, 18, 33], "unchang": [3, 27], "uncompress": 3, "undefin": 21, "under": [2, 20], "underli": [4, 7, 20], "unfortun": 20, "unicod": [4, 5, 7], "union": [3, 4, 5], "union_distinct": 3, "uniqu": [2, 5, 6, 18, 24], "unit": [4, 7, 33], "unixtim": 5, "unknown": 4, "unlik": [4, 7, 33], "unmatch": 29, "unnest": [3, 4], "unnest_column": 3, "unnestexpr": 4, "unoptim": 3, "unpars": [7, 19], "unsaf": 20, "unspil": [2, 7], "until": 23, "unwrap": 44, "up": [7, 13, 18, 23, 26, 33], "updat": [2, 3, 7, 18, 31], "upon": [5, 20, 31], "upper": [4, 5, 7], "uppercas": [4, 5, 7], "upstream": 20, "urbango": 29, "url": 2, "us": [2, 3, 4, 5, 6, 7, 8, 9, 11, 13, 15, 18, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 35, 36, 37, 38, 40, 42, 43, 44], "usag": [2, 3, 4, 5, 7, 18, 24, 33], "use_shared_styl": [6, 7, 36], "user": [0, 2, 3, 4, 5, 7, 8, 13, 14, 15, 16, 17, 18, 20, 21, 23, 26, 27, 28, 35, 37], "user_defin": [2, 7, 19, 31], "uses_window_fram": [18, 31], "utc": 5, "utf8": [4, 5, 7], "utf8view": [4, 7], "util": [6, 20, 33], "uuid": 5, "uv": 21, "v": 21, "v4": 5, "valid": [2, 4, 6, 7, 8, 9, 10, 18], "valu": [2, 3, 4, 5, 6, 7, 13, 18, 24, 26, 28, 29, 30, 31, 33, 36], "value1": 5, "value2": 5, "value_i": 5, "value_x": 5, "valueerror": [3, 6, 7], "values_a": 31, "values_b": 31, "var": 5, "var_pop": [5, 24], "var_samp": [5, 24], "var_sampl": 5, "variabl": [2, 5, 7, 21, 26], "varianc": 5, "variant": [4, 7, 13, 29], "variant_nam": [4, 7], "varieti": [26, 31, 35], "variou": 37, "vastli": 21, "vec": 20, "vendorid": 30, "venomoth": 33, "venonat": 33, "venu": 27, "venufleur": 27, "venufleurmega": 27, "venusaur": [22, 27, 33, 35, 37], "venusaurmega": [22, 27, 33, 35, 37], "venv": 21, "verbos": 3, "veri": [39, 40], "verifi": 37, "verion": 35, "version": [20, 21, 35], "via": [2, 15, 20, 21, 22, 26, 29, 31, 35, 37, 44, 45], "view": [2, 25, 27, 28, 37], "view1": 32, "viewtabl": 3, "vink": 33, "virtual": [2, 7, 21], "visual": [7, 13, 23, 36], "volatil": [7, 18, 31], "voltorb": [24, 33], "vulpix": 24, "wa": [2, 7], "wai": [20, 21, 24, 35, 37], "wait": 20, "want": [20, 21, 24, 27, 31, 33, 44], "wartortl": [22, 35, 37], "water": [22, 24, 27, 35, 37], "we": [3, 20, 21, 23, 24, 26, 27, 29, 30, 31, 33, 34, 37, 38], "weedl": [22, 33, 35, 37], "weight": [5, 26], "welcom": [21, 37], "well": [2, 7, 20, 21], "were": [20, 26], "what": [20, 23], "whatev": 18, "when": [2, 4, 5, 6, 7, 11, 18, 20, 21, 22, 24, 26, 29, 31, 33, 34, 36, 42], "when_expr": 4, "whenev": 21, "where": [3, 4, 5, 7, 13, 24, 26, 27, 31, 32, 33], "wherea": 26, "wherev": 20, "whether": [2, 4, 5, 6, 7, 11, 18, 26], "which": [2, 3, 4, 5, 7, 18, 20, 21, 22, 24, 26, 30, 31, 33, 35, 38], "while": [18, 29], "white": 36, "who": 20, "whole": 24, "wide": [26, 34, 35], "width": [6, 36], "window": [2, 4, 5, 7, 18, 24, 28], "window_fram": [4, 5, 7, 33], "windowevalu": [7, 18, 31], "windowexpr": 4, "windowfram": [4, 5, 7, 33], "windowframebound": [4, 7], "windowudf": [2, 7, 18], "wish": [20, 31], "with_allow_ddl": [2, 7], "with_allow_dml": [2, 7], "with_allow_stat": [2, 7], "with_batch_s": [2, 7], "with_column": 3, "with_column_renam": 3, "with_create_default_catalog_and_schema": [2, 7, 34], "with_default_catalog_and_schema": [2, 7, 34], "with_disk_manager_dis": [2, 7], "with_disk_manager_o": [2, 7, 34], "with_disk_manager_specifi": [2, 7], "with_fair_spill_pool": [2, 7, 34], "with_greedy_memory_pool": [2, 7], "with_head": 3, "with_information_schema": [2, 7, 34], "with_parquet_prun": [2, 7, 34], "with_pretti": 17, "with_repartition_aggreg": [2, 7, 34], "with_repartition_file_min_s": [2, 7], "with_repartition_file_scan": [2, 7], "with_repartition_join": [2, 7, 34], "with_repartition_sort": [2, 7], "with_repartition_window": [2, 7, 34], "with_target_partit": [2, 7, 34], "with_temp_file_path": [2, 7], "with_unbounded_memory_pool": [2, 7], "within": [5, 9, 18, 24, 26], "within_limit": 3, "without": [4, 5, 7, 20, 21, 24, 27, 29, 30, 31], "won": 30, "word": [4, 5, 7], "work": [2, 5, 7, 23, 27, 30, 36, 37], "workflow": 21, "would": [4, 5, 8, 18, 20], "wrap": [2, 3, 20], "wrapper": [2, 7, 14, 21], "write": [3, 8, 15, 20, 31], "write_csv": 3, "write_json": 3, "write_parquet": 3, "written": [20, 22], "x": [5, 7, 18, 22, 27, 33, 35, 37, 45], "xor": 5, "y": [5, 18, 22, 27, 33, 35, 37], "year": 5, "years_in_posit": 26, "yellow": [23, 35], "yellow_tripdata_2021": [23, 30], "yet": 3, "yield": 5, "you": [2, 5, 7, 18, 20, 21, 22, 23, 24, 25, 26, 27, 30, 31, 32, 33, 34, 35, 36, 37, 38, 44], "your": [7, 18, 20, 21, 24, 25, 30, 31, 36, 44], "yourself": 20, "z": [2, 7, 18], "zero": [3, 5, 22, 38], "zstandard": 3, "zstd": 3, "zubat": 24, "\u03c0": 5}, "titles": ["datafusion.catalog", "datafusion.col", "datafusion.context", "datafusion.dataframe", "datafusion.expr", "datafusion.functions", "datafusion.html_formatter", "datafusion", "datafusion.input.base", "datafusion.input", "datafusion.input.location", "datafusion.io", "datafusion.object_store", "datafusion.plan", "datafusion.record_batch", "datafusion.substrait", "datafusion.udf", "datafusion.unparser", "datafusion.user_defined", "API Reference", "Python Extensions", "Introduction", "DataFusion in Python", "Concepts", "Aggregation", "Basic Operations", "Expressions", "Functions", "Common Operations", "Joins", "Column Selections", "User-Defined Functions", "Registering Views", "Window Functions", "Configuration", "Data Sources", "DataFrames", "Introduction", "Arrow", "Avro", "CSV", "IO", "JSON", "Parquet", "Custom Table Provider", "SQL"], "titleterms": {"The": 20, "aggreg": [24, 31, 33], "altern": 20, "anti": 29, "api": 19, "approach": 20, "arrai": 26, "arrow": [20, 38], "attribut": [1, 4, 7, 12, 18], "avail": 33, "avro": 39, "base": 8, "basic": [25, 36], "boolean": 26, "build": 21, "cast": 27, "catalog": 0, "class": [0, 2, 3, 4, 6, 7, 8, 9, 10, 13, 14, 15, 17, 18], "code": 21, "col": 1, "column": [26, 30], "commit": 21, "common": 28, "concept": 23, "condit": 27, "configur": 34, "content": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17, 18], "context": [2, 23], "contextu": 36, "control": 36, "creat": [35, 36], "csv": 40, "custom": [35, 36, 44], "data": 35, "datafram": [3, 23, 35, 36], "datafus": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 22, 38], "defin": 31, "delta": 35, "depend": 21, "detail": 20, "develop": 21, "displai": 36, "distinct": 24, "exampl": 22, "export": 38, "expr": 4, "express": [23, 26], "extens": 20, "ffi": 20, "file": 35, "fill_nul": 27, "filter": 24, "format": 36, "formatt": 36, "frame": 33, "from": [20, 38], "full": 29, "function": [5, 6, 7, 11, 24, 26, 27, 31, 33], "guidelin": 21, "handl": 27, "hook": 21, "how": 21, "html": 36, "html_formatt": 6, "iceberg": 35, "implement": 20, "import": 38, "improv": 21, "inner": 29, "input": [8, 9, 10], "inspir": 20, "instal": [21, 22, 37], "introduct": [21, 37], "io": [11, 41], "issu": 20, "join": 29, "json": 42, "lake": 35, "left": 29, "librari": 35, "liter": 26, "local": 35, "locat": 10, "manag": 36, "mathemat": 27, "memori": [35, 36], "miss": 27, "modul": [0, 1, 2, 3, 4, 5, 6, 8, 10, 11, 12, 13, 14, 15, 17, 18], "null": [24, 33], "object": 35, "object_stor": 12, "oper": [25, 28], "optim": 36, "option": 31, "order": [24, 33], "other": [27, 35], "overview": 36, "packag": [7, 9], "paramet": [24, 33], "parquet": 43, "partit": 33, "perform": 36, "plan": 13, "pre": 21, "primari": 20, "provid": [35, 36, 44], "python": [20, 21, 22], "record_batch": 14, "refer": 19, "regist": 32, "render": 36, "return": [4, 5, 7], "run": 21, "rust": 21, "scalar": 31, "select": 30, "semi": 29, "separ": 21, "session": 23, "set": [24, 33], "share": 36, "sourc": 35, "speed": 21, "sql": 45, "statu": 20, "store": 35, "string": 27, "struct": 26, "style": 36, "submodul": [7, 9], "substrait": 15, "tabl": [31, 35, 44], "tempor": 27, "treatment": [24, 33], "udf": 16, "udwf": 31, "unpars": 17, "updat": 21, "usag": 36, "user": 31, "user_defin": 18, "valu": 27, "view": 32, "window": [31, 33], "work": 20}}) \ No newline at end of file
diff --git a/user-guide/basics.html b/user-guide/basics.html index ab96577..3596aa2 100644 --- a/user-guide/basics.html +++ b/user-guide/basics.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul> @@ -413,8 +438,9 @@ <section id="concepts"> <span id="user-guide-concepts"></span><h1>Concepts<a class="headerlink" href="#concepts" title="Link to this heading">¶</a></h1> -<p>In this section, we will cover a basic example to introduce a few key concepts. We will use the same -source file as described in the <a class="reference internal" href="introduction.html#guide"><span class="std std-ref">Introduction</span></a>, the Pokemon data set.</p> +<p>In this section, we will cover a basic example to introduce a few key concepts. We will use the +2021 Yellow Taxi Trip Records (<a class="reference external" href="https://d37ci6vzurychx.cloudfront.net/trip-data/yellow_tripdata_2021-01.parquet">download</a>), +from the <a class="reference external" href="https://www.nyc.gov/site/tlc/about/tlc-trip-record-data.page">TLC Trip Record Data</a>.</p> <div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="n">In</span> <span class="p">[</span><span class="mi">1</span><span class="p">]:</span> <span class="kn">from</span><span class="w"> </span><span class="nn">datafusion</span><span class="w"> </span><span class="kn">import</span> <span class="n">SessionContext</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">lit</span><span class="p">,</span> <span class="n">functions</span> <span class="k">as</span> <span class="n">f</span> <span class="n">In</span> <span class="p">[</span><span class="mi">2</span><span class="p">]:</span> <span class="n">ctx</span> <span class="o">=</span> <span class="n">SessionContext</span><span class="p">()</span> @@ -483,6 +509,7 @@ DataFrames are typically created by calling a method on <a class="reference internal" href="../autoapi/datafusion/context/index.html#datafusion.context.SessionContext" title="datafusion.context.SessionContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">SessionContext</span></code></a>, such as <code class="code docutils literal notranslate"><span class="pre">read_csv</span></code>, and can then be modified by calling the transformation methods, such as <a class="reference internal" href="../autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.filter" title="datafusion.dataframe.DataFrame.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">filter()</span></code></a>, <a class="reference internal" href="../autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.select" title="datafusion.dataframe.DataFrame.select"><code class="xref py py-func docutils literal notranslate"><span class="pre">select()</span></code></a>, <a class="reference internal" href="../autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.aggregate" title="datafusion.dataframe.DataFrame.aggregate"><code class="xref py py-func docutils literal notranslate"><span class="pre">aggregate()</span></code></a>, and <a class="reference internal" href="../autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.limit" title="datafusion.dataframe.DataFrame.limit"><code class="xref py py-func docutils literal notranslate"><span class="pre">limit()</span></code></a> to build up a query definition.</p> +<p>For more details on working with DataFrames, including visualization options and conversion to other formats, see <a class="reference internal" href="dataframe.html"><span class="doc">DataFrames</span></a>.</p> </section> <section id="expressions"> <h2>Expressions<a class="headerlink" href="#expressions" title="Link to this heading">¶</a></h2>
diff --git a/user-guide/common-operations/aggregations.html b/user-guide/common-operations/aggregations.html index 9235368..f35abc6 100644 --- a/user-guide/common-operations/aggregations.html +++ b/user-guide/common-operations/aggregations.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul> @@ -579,15 +604,15 @@ <span class="o">|</span> <span class="n">Type</span> <span class="mi">1</span> <span class="o">|</span> <span class="n">Type</span> <span class="mi">2</span> <span class="n">List</span> <span class="o">|</span> <span class="o">+----------+--------------------------------------------------+</span> <span class="o">|</span> <span class="n">Bug</span> <span class="o">|</span> <span class="p">[,</span> <span class="n">Grass</span><span class="p">,</span> <span class="n">Flying</span><span class="p">,</span> <span class="n">Poison</span><span class="p">]</span> <span class="o">|</span> -<span class="o">|</span> <span class="n">Poison</span> <span class="o">|</span> <span class="p">[,</span> <span class="n">Flying</span><span class="p">,</span> <span class="n">Ground</span><span class="p">]</span> <span class="o">|</span> -<span class="o">|</span> <span class="n">Electric</span> <span class="o">|</span> <span class="p">[,</span> <span class="n">Steel</span><span class="p">,</span> <span class="n">Flying</span><span class="p">]</span> <span class="o">|</span> +<span class="o">|</span> <span class="n">Poison</span> <span class="o">|</span> <span class="p">[,</span> <span class="n">Ground</span><span class="p">,</span> <span class="n">Flying</span><span class="p">]</span> <span class="o">|</span> +<span class="o">|</span> <span class="n">Electric</span> <span class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span class="p">,</span> <span class="n">Steel</span><span class="p">,</span> <span class="p">]</span> <span class="o">|</span> <span class="o">|</span> <span class="n">Fairy</span> <span class="o">|</span> <span class="p">[]</span> <span class="o">|</span> -<span class="o">|</span> <span class="n">Normal</span> <span class="o">|</span> <span class="p">[,</span> <span class="n">Flying</span><span class="p">,</span> <span class="n">Fairy</span><span class="p">]</span> <span class="o">|</span> +<span class="o">|</span> <span class="n">Normal</span> <span class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span class="p">,</span> <span class="n">Fairy</span><span class="p">,</span> <span class="p">]</span> <span class="o">|</span> <span class="o">|</span> <span class="n">Ice</span> <span class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span class="p">,</span> <span class="n">Psychic</span><span class="p">]</span> <span class="o">|</span> <span class="o">|</span> <span class="n">Grass</span> <span class="o">|</span> <span class="p">[</span><span class="n">Psychic</span><span class="p">,</span> <span class="p">,</span> <span class="n">Poison</span><span class="p">]</span> <span class="o">|</span> -<span class="o">|</span> <span class="n">Fire</span> <span class="o">|</span> <span class="p">[</span><span class="n">Dragon</span><span class="p">,</span> <span class="n">Flying</span><span class="p">,</span> <span class="p">]</span> <span class="o">|</span> -<span class="o">|</span> <span class="n">Water</span> <span class="o">|</span> <span class="p">[</span><span class="n">Fighting</span><span class="p">,</span> <span class="n">Flying</span><span class="p">,</span> <span class="n">Psychic</span><span class="p">,</span> <span class="n">Poison</span><span class="p">,</span> <span class="p">,</span> <span class="n">Dark</span><span class="p">,</span> <span class="n">Ice</span><span class="p">]</span> <span class="o">|</span> -<span class="o">|</span> <span class="n">Ground</span> <span class="o">|</span> <span class="p">[</span><span class="n">Rock</span><span class="p">,</span> <span class="p">]</span> <span class="o">|</span> +<span class="o">|</span> <span class="n">Fire</span> <span class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span class="p">,</span> <span class="p">,</span> <span class="n">Dragon</span><span class="p">]</span> <span class="o">|</span> +<span class="o">|</span> <span class="n">Water</span> <span class="o">|</span> <span class="p">[</span><span class="n">Ice</span><span class="p">,</span> <span class="n">Flying</span><span class="p">,</span> <span class="p">,</span> <span class="n">Fighting</span><span class="p">,</span> <span class="n">Dark</span><span class="p">,</span> <span class="n">Psychic</span><span class="p">,</span> <span class="n">Poison</span><span class="p">]</span> <span class="o">|</span> +<span class="o">|</span> <span class="n">Ground</span> <span class="o">|</span> <span class="p">[,</span> <span class="n">Rock</span><span class="p">]</span> <span class="o">|</span> <span class="o">+----------+--------------------------------------------------+</span> <span class="n">Data</span> <span class="n">truncated</span><span class="o">.</span> </pre></div> @@ -602,15 +627,15 @@ <span class="o">+----------+------------------------------------------------+</span> <span class="o">|</span> <span class="n">Type</span> <span class="mi">1</span> <span class="o">|</span> <span class="n">Type</span> <span class="mi">2</span> <span class="n">List</span> <span class="o">|</span> <span class="o">+----------+------------------------------------------------+</span> -<span class="o">|</span> <span class="n">Bug</span> <span class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span class="p">,</span> <span class="n">Grass</span><span class="p">,</span> <span class="n">Poison</span><span class="p">]</span> <span class="o">|</span> -<span class="o">|</span> <span class="n">Poison</span> <span class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span class="p">,</span> <span class="n">Ground</span><span class="p">]</span> <span class="o">|</span> +<span class="o">|</span> <span class="n">Bug</span> <span class="o">|</span> <span class="p">[</span><span class="n">Poison</span><span class="p">,</span> <span class="n">Grass</span><span class="p">,</span> <span class="n">Flying</span><span class="p">]</span> <span class="o">|</span> +<span class="o">|</span> <span class="n">Poison</span> <span class="o">|</span> <span class="p">[</span><span class="n">Ground</span><span class="p">,</span> <span class="n">Flying</span><span class="p">]</span> <span class="o">|</span> <span class="o">|</span> <span class="n">Electric</span> <span class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span class="p">,</span> <span class="n">Steel</span><span class="p">]</span> <span class="o">|</span> <span class="o">|</span> <span class="n">Normal</span> <span class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span class="p">,</span> <span class="n">Fairy</span><span class="p">]</span> <span class="o">|</span> <span class="o">|</span> <span class="n">Ice</span> <span class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span class="p">,</span> <span class="n">Psychic</span><span class="p">]</span> <span class="o">|</span> -<span class="o">|</span> <span class="n">Grass</span> <span class="o">|</span> <span class="p">[</span><span class="n">Poison</span><span class="p">,</span> <span class="n">Psychic</span><span class="p">]</span> <span class="o">|</span> +<span class="o">|</span> <span class="n">Grass</span> <span class="o">|</span> <span class="p">[</span><span class="n">Psychic</span><span class="p">,</span> <span class="n">Poison</span><span class="p">]</span> <span class="o">|</span> <span class="o">|</span> <span class="n">Fire</span> <span class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span class="p">,</span> <span class="n">Dragon</span><span class="p">]</span> <span class="o">|</span> -<span class="o">|</span> <span class="n">Water</span> <span class="o">|</span> <span class="p">[</span><span class="n">Psychic</span><span class="p">,</span> <span class="n">Flying</span><span class="p">,</span> <span class="n">Fighting</span><span class="p">,</span> <span class="n">Dark</span><span class="p">,</span> <span class="n">Poison</span><span class="p">,</span> <span class="n">Ice</span><span class="p">]</span> <span class="o">|</span> -<span class="o">|</span> <span class="n">Rock</span> <span class="o">|</span> <span class="p">[</span><span class="n">Ground</span><span class="p">,</span> <span class="n">Water</span><span class="p">,</span> <span class="n">Flying</span><span class="p">]</span> <span class="o">|</span> +<span class="o">|</span> <span class="n">Water</span> <span class="o">|</span> <span class="p">[</span><span class="n">Dark</span><span class="p">,</span> <span class="n">Poison</span><span class="p">,</span> <span class="n">Psychic</span><span class="p">,</span> <span class="n">Flying</span><span class="p">,</span> <span class="n">Ice</span><span class="p">,</span> <span class="n">Fighting</span><span class="p">]</span> <span class="o">|</span> +<span class="o">|</span> <span class="n">Rock</span> <span class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span class="p">,</span> <span class="n">Water</span><span class="p">,</span> <span class="n">Ground</span><span class="p">]</span> <span class="o">|</span> <span class="o">|</span> <span class="n">Ghost</span> <span class="o">|</span> <span class="p">[</span><span class="n">Poison</span><span class="p">]</span> <span class="o">|</span> <span class="o">+----------+------------------------------------------------+</span> <span class="n">Data</span> <span class="n">truncated</span><span class="o">.</span> @@ -621,15 +646,15 @@ <span class="o">+----------+------------------------------------------------+</span> <span class="o">|</span> <span class="n">Type</span> <span class="mi">1</span> <span class="o">|</span> <span class="n">Type</span> <span class="mi">2</span> <span class="n">List</span> <span class="o">|</span> <span class="o">+----------+------------------------------------------------+</span> -<span class="o">|</span> <span class="n">Bug</span> <span class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span class="p">,</span> <span class="n">Grass</span><span class="p">,</span> <span class="n">Poison</span><span class="p">]</span> <span class="o">|</span> -<span class="o">|</span> <span class="n">Poison</span> <span class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span class="p">,</span> <span class="n">Ground</span><span class="p">]</span> <span class="o">|</span> +<span class="o">|</span> <span class="n">Bug</span> <span class="o">|</span> <span class="p">[</span><span class="n">Grass</span><span class="p">,</span> <span class="n">Flying</span><span class="p">,</span> <span class="n">Poison</span><span class="p">]</span> <span class="o">|</span> +<span class="o">|</span> <span class="n">Poison</span> <span class="o">|</span> <span class="p">[</span><span class="n">Ground</span><span class="p">,</span> <span class="n">Flying</span><span class="p">]</span> <span class="o">|</span> <span class="o">|</span> <span class="n">Electric</span> <span class="o">|</span> <span class="p">[</span><span class="n">Steel</span><span class="p">,</span> <span class="n">Flying</span><span class="p">]</span> <span class="o">|</span> <span class="o">|</span> <span class="n">Fairy</span> <span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="n">Normal</span> <span class="o">|</span> <span class="p">[</span><span class="n">Fairy</span><span class="p">,</span> <span class="n">Flying</span><span class="p">]</span> <span class="o">|</span> -<span class="o">|</span> <span class="n">Ice</span> <span class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span class="p">,</span> <span class="n">Psychic</span><span class="p">]</span> <span class="o">|</span> +<span class="o">|</span> <span class="n">Ice</span> <span class="o">|</span> <span class="p">[</span><span class="n">Psychic</span><span class="p">,</span> <span class="n">Flying</span><span class="p">]</span> <span class="o">|</span> <span class="o">|</span> <span class="n">Grass</span> <span class="o">|</span> <span class="p">[</span><span class="n">Psychic</span><span class="p">,</span> <span class="n">Poison</span><span class="p">]</span> <span class="o">|</span> -<span class="o">|</span> <span class="n">Fire</span> <span class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span class="p">,</span> <span class="n">Dragon</span><span class="p">]</span> <span class="o">|</span> -<span class="o">|</span> <span class="n">Water</span> <span class="o">|</span> <span class="p">[</span><span class="n">Ice</span><span class="p">,</span> <span class="n">Dark</span><span class="p">,</span> <span class="n">Fighting</span><span class="p">,</span> <span class="n">Flying</span><span class="p">,</span> <span class="n">Poison</span><span class="p">,</span> <span class="n">Psychic</span><span class="p">]</span> <span class="o">|</span> +<span class="o">|</span> <span class="n">Fire</span> <span class="o">|</span> <span class="p">[</span><span class="n">Dragon</span><span class="p">,</span> <span class="n">Flying</span><span class="p">]</span> <span class="o">|</span> +<span class="o">|</span> <span class="n">Water</span> <span class="o">|</span> <span class="p">[</span><span class="n">Ice</span><span class="p">,</span> <span class="n">Flying</span><span class="p">,</span> <span class="n">Poison</span><span class="p">,</span> <span class="n">Dark</span><span class="p">,</span> <span class="n">Psychic</span><span class="p">,</span> <span class="n">Fighting</span><span class="p">]</span> <span class="o">|</span> <span class="o">|</span> <span class="n">Ground</span> <span class="o">|</span> <span class="p">[</span><span class="n">Rock</span><span class="p">]</span> <span class="o">|</span> <span class="o">+----------+------------------------------------------------+</span> <span class="n">Data</span> <span class="n">truncated</span><span class="o">.</span>
diff --git a/user-guide/common-operations/basic-info.html b/user-guide/common-operations/basic-info.html index f7c6612..3657b74 100644 --- a/user-guide/common-operations/basic-info.html +++ b/user-guide/common-operations/basic-info.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul> @@ -414,11 +439,11 @@ <span class="o">+-----+---------+--------+--------+</span> <span class="o">|</span> <span class="n">nrs</span> <span class="o">|</span> <span class="n">names</span> <span class="o">|</span> <span class="n">random</span> <span class="o">|</span> <span class="n">groups</span> <span class="o">|</span> <span class="o">+-----+---------+--------+--------+</span> -<span class="o">|</span> <span class="mi">1</span> <span class="o">|</span> <span class="n">python</span> <span class="o">|</span> <span class="mi">832</span> <span class="o">|</span> <span class="n">A</span> <span class="o">|</span> -<span class="o">|</span> <span class="mi">2</span> <span class="o">|</span> <span class="n">ruby</span> <span class="o">|</span> <span class="mi">669</span> <span class="o">|</span> <span class="n">A</span> <span class="o">|</span> -<span class="o">|</span> <span class="mi">3</span> <span class="o">|</span> <span class="n">java</span> <span class="o">|</span> <span class="mi">803</span> <span class="o">|</span> <span class="n">B</span> <span class="o">|</span> -<span class="o">|</span> <span class="mi">4</span> <span class="o">|</span> <span class="n">haskell</span> <span class="o">|</span> <span class="mi">531</span> <span class="o">|</span> <span class="n">C</span> <span class="o">|</span> -<span class="o">|</span> <span class="mi">5</span> <span class="o">|</span> <span class="n">go</span> <span class="o">|</span> <span class="mi">774</span> <span class="o">|</span> <span class="n">B</span> <span class="o">|</span> +<span class="o">|</span> <span class="mi">1</span> <span class="o">|</span> <span class="n">python</span> <span class="o">|</span> <span class="mi">316</span> <span class="o">|</span> <span class="n">A</span> <span class="o">|</span> +<span class="o">|</span> <span class="mi">2</span> <span class="o">|</span> <span class="n">ruby</span> <span class="o">|</span> <span class="mi">698</span> <span class="o">|</span> <span class="n">A</span> <span class="o">|</span> +<span class="o">|</span> <span class="mi">3</span> <span class="o">|</span> <span class="n">java</span> <span class="o">|</span> <span class="mi">568</span> <span class="o">|</span> <span class="n">B</span> <span class="o">|</span> +<span class="o">|</span> <span class="mi">4</span> <span class="o">|</span> <span class="n">haskell</span> <span class="o">|</span> <span class="mi">804</span> <span class="o">|</span> <span class="n">C</span> <span class="o">|</span> +<span class="o">|</span> <span class="mi">5</span> <span class="o">|</span> <span class="n">go</span> <span class="o">|</span> <span class="mi">513</span> <span class="o">|</span> <span class="n">B</span> <span class="o">|</span> <span class="o">+-----+---------+--------+--------+</span> </pre></div> </div> @@ -429,8 +454,8 @@ <span class="o">+-----+--------+--------+--------+</span> <span class="o">|</span> <span class="n">nrs</span> <span class="o">|</span> <span class="n">names</span> <span class="o">|</span> <span class="n">random</span> <span class="o">|</span> <span class="n">groups</span> <span class="o">|</span> <span class="o">+-----+--------+--------+--------+</span> -<span class="o">|</span> <span class="mi">1</span> <span class="o">|</span> <span class="n">python</span> <span class="o">|</span> <span class="mi">832</span> <span class="o">|</span> <span class="n">A</span> <span class="o">|</span> -<span class="o">|</span> <span class="mi">2</span> <span class="o">|</span> <span class="n">ruby</span> <span class="o">|</span> <span class="mi">669</span> <span class="o">|</span> <span class="n">A</span> <span class="o">|</span> +<span class="o">|</span> <span class="mi">1</span> <span class="o">|</span> <span class="n">python</span> <span class="o">|</span> <span class="mi">316</span> <span class="o">|</span> <span class="n">A</span> <span class="o">|</span> +<span class="o">|</span> <span class="mi">2</span> <span class="o">|</span> <span class="n">ruby</span> <span class="o">|</span> <span class="mi">698</span> <span class="o">|</span> <span class="n">A</span> <span class="o">|</span> <span class="o">+-----+--------+--------+--------+</span> </pre></div> </div> @@ -448,28 +473,28 @@ <div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="n">In</span> <span class="p">[</span><span class="mi">8</span><span class="p">]:</span> <span class="n">df</span><span class="o">.</span><span class="n">to_pandas</span><span class="p">()</span> <span class="n">Out</span><span class="p">[</span><span class="mi">8</span><span class="p">]:</span> <span class="n">nrs</span> <span class="n">names</span> <span class="n">random</span> <span class="n">groups</span> -<span class="mi">0</span> <span class="mi">1</span> <span class="n">python</span> <span class="mi">832</span> <span class="n">A</span> -<span class="mi">1</span> <span class="mi">2</span> <span class="n">ruby</span> <span class="mi">669</span> <span class="n">A</span> -<span class="mi">2</span> <span class="mi">3</span> <span class="n">java</span> <span class="mi">803</span> <span class="n">B</span> -<span class="mi">3</span> <span class="mi">4</span> <span class="n">haskell</span> <span class="mi">531</span> <span class="n">C</span> -<span class="mi">4</span> <span class="mi">5</span> <span class="n">go</span> <span class="mi">774</span> <span class="n">B</span> +<span class="mi">0</span> <span class="mi">1</span> <span class="n">python</span> <span class="mi">316</span> <span class="n">A</span> +<span class="mi">1</span> <span class="mi">2</span> <span class="n">ruby</span> <span class="mi">698</span> <span class="n">A</span> +<span class="mi">2</span> <span class="mi">3</span> <span class="n">java</span> <span class="mi">568</span> <span class="n">B</span> +<span class="mi">3</span> <span class="mi">4</span> <span class="n">haskell</span> <span class="mi">804</span> <span class="n">C</span> +<span class="mi">4</span> <span class="mi">5</span> <span class="n">go</span> <span class="mi">513</span> <span class="n">B</span> </pre></div> </div> <p><a class="reference internal" href="../../autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.describe" title="datafusion.dataframe.DataFrame.describe"><code class="xref py py-func docutils literal notranslate"><span class="pre">describe()</span></code></a> shows a quick statistic summary of your data:</p> <div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="n">In</span> <span class="p">[</span><span class="mi">9</span><span class="p">]:</span> <span class="n">df</span><span class="o">.</span><span class="n">describe</span><span class="p">()</span> <span class="n">Out</span><span class="p">[</span><span class="mi">9</span><span class="p">]:</span> <span class="n">DataFrame</span><span class="p">()</span> -<span class="o">+------------+--------------------+-------+--------------------+--------+</span> -<span class="o">|</span> <span class="n">describe</span> <span class="o">|</span> <span class="n">nrs</span> <span class="o">|</span> <span class="n">names</span> <span class="o">|</span> <span class="n">random</span> <span class="o">|</span> <span class="n">groups</span> <span class="o">|</span> -<span class="o">+------------+--------------------+-------+--------------------+--------+</span> -<span class="o">|</span> <span class="n">count</span> <span class="o">|</span> <span class="mf">5.0</span> <span class="o">|</span> <span class="mi">5</span> <span class="o">|</span> <span class="mf">5.0</span> <span class="o">|</span> <span class="mi">5</span> <span class="o">|</span> -<span class="o">|</span> <span class="n">null_count</span> <span class="o">|</span> <span class="mf">0.0</span> <span class="o">|</span> <span class="mi">0</span> <span class="o">|</span> <span class="mf">0.0</span> <span class="o">|</span> <span class="mi">0</span> <span class="o">|</span> -<span class="o">|</span> <span class="n">mean</span> <span class="o">|</span> <span class="mf">3.0</span> <span class="o">|</span> <span class="n">null</span> <span class="o">|</span> <span class="mf">721.8</span> <span class="o">|</span> <span class="n">null</span> <span class="o">|</span> -<span class="o">|</span> <span class="n">std</span> <span class="o">|</span> <span class="mf">1.5811388300841898</span> <span class="o">|</span> <span class="n">null</span> <span class="o">|</span> <span class="mf">123.14097612086726</span> <span class="o">|</span> <span class="n">null</span> <span class="o">|</span> -<span class="o">|</span> <span class="nb">min</span> <span class="o">|</span> <span class="mf">1.0</span> <span class="o">|</span> <span class="n">go</span> <span class="o">|</span> <span class="mf">531.0</span> <span class="o">|</span> <span class="n">A</span> <span class="o">|</span> -<span class="o">|</span> <span class="nb">max</span> <span class="o">|</span> <span class="mf">5.0</span> <span class="o">|</span> <span class="n">ruby</span> <span class="o">|</span> <span class="mf">832.0</span> <span class="o">|</span> <span class="n">C</span> <span class="o">|</span> -<span class="o">|</span> <span class="n">median</span> <span class="o">|</span> <span class="mf">3.0</span> <span class="o">|</span> <span class="n">null</span> <span class="o">|</span> <span class="mf">774.0</span> <span class="o">|</span> <span class="n">null</span> <span class="o">|</span> -<span class="o">+------------+--------------------+-------+--------------------+--------+</span> +<span class="o">+------------+--------------------+-------+-------------------+--------+</span> +<span class="o">|</span> <span class="n">describe</span> <span class="o">|</span> <span class="n">nrs</span> <span class="o">|</span> <span class="n">names</span> <span class="o">|</span> <span class="n">random</span> <span class="o">|</span> <span class="n">groups</span> <span class="o">|</span> +<span class="o">+------------+--------------------+-------+-------------------+--------+</span> +<span class="o">|</span> <span class="n">count</span> <span class="o">|</span> <span class="mf">5.0</span> <span class="o">|</span> <span class="mi">5</span> <span class="o">|</span> <span class="mf">5.0</span> <span class="o">|</span> <span class="mi">5</span> <span class="o">|</span> +<span class="o">|</span> <span class="n">null_count</span> <span class="o">|</span> <span class="mf">0.0</span> <span class="o">|</span> <span class="mi">0</span> <span class="o">|</span> <span class="mf">0.0</span> <span class="o">|</span> <span class="mi">0</span> <span class="o">|</span> +<span class="o">|</span> <span class="n">mean</span> <span class="o">|</span> <span class="mf">3.0</span> <span class="o">|</span> <span class="n">null</span> <span class="o">|</span> <span class="mf">579.8</span> <span class="o">|</span> <span class="n">null</span> <span class="o">|</span> +<span class="o">|</span> <span class="n">std</span> <span class="o">|</span> <span class="mf">1.5811388300841898</span> <span class="o">|</span> <span class="n">null</span> <span class="o">|</span> <span class="mf">186.0301050905471</span> <span class="o">|</span> <span class="n">null</span> <span class="o">|</span> +<span class="o">|</span> <span class="nb">min</span> <span class="o">|</span> <span class="mf">1.0</span> <span class="o">|</span> <span class="n">go</span> <span class="o">|</span> <span class="mf">316.0</span> <span class="o">|</span> <span class="n">A</span> <span class="o">|</span> +<span class="o">|</span> <span class="nb">max</span> <span class="o">|</span> <span class="mf">5.0</span> <span class="o">|</span> <span class="n">ruby</span> <span class="o">|</span> <span class="mf">804.0</span> <span class="o">|</span> <span class="n">C</span> <span class="o">|</span> +<span class="o">|</span> <span class="n">median</span> <span class="o">|</span> <span class="mf">3.0</span> <span class="o">|</span> <span class="n">null</span> <span class="o">|</span> <span class="mf">568.0</span> <span class="o">|</span> <span class="n">null</span> <span class="o">|</span> +<span class="o">+------------+--------------------+-------+-------------------+--------+</span> </pre></div> </div> </section>
diff --git a/user-guide/common-operations/expressions.html b/user-guide/common-operations/expressions.html index 0fe3e29..2912450 100644 --- a/user-guide/common-operations/expressions.html +++ b/user-guide/common-operations/expressions.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/user-guide/common-operations/functions.html b/user-guide/common-operations/functions.html index 803c266..61123ed 100644 --- a/user-guide/common-operations/functions.html +++ b/user-guide/common-operations/functions.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul> @@ -375,35 +400,54 @@ <nav id="bd-toc-nav"> <ul class="visible nav section-nav flex-column"> - <li class="toc-h2 nav-item toc-entry"> - <a class="reference internal nav-link" href="#mathematical"> - Mathematical + <li class="toc-h1 nav-item toc-entry"> + <a class="reference internal nav-link" href="#"> + Functions </a> + <ul class="visible nav section-nav flex-column"> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#mathematical"> + Mathematical + </a> + </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#conditional"> + Conditional + </a> + </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#temporal"> + Temporal + </a> + </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#string"> + String + </a> + </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#casting"> + Casting + </a> + </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#other"> + Other + </a> + </li> + </ul> </li> - <li class="toc-h2 nav-item toc-entry"> - <a class="reference internal nav-link" href="#conditional"> - Conditional + <li class="toc-h1 nav-item toc-entry"> + <a class="reference internal nav-link" href="#handling-missing-values"> + Handling Missing Values </a> - </li> - <li class="toc-h2 nav-item toc-entry"> - <a class="reference internal nav-link" href="#temporal"> - Temporal - </a> - </li> - <li class="toc-h2 nav-item toc-entry"> - <a class="reference internal nav-link" href="#string"> - String - </a> - </li> - <li class="toc-h2 nav-item toc-entry"> - <a class="reference internal nav-link" href="#casting"> - Casting - </a> - </li> - <li class="toc-h2 nav-item toc-entry"> - <a class="reference internal nav-link" href="#other"> - Other - </a> + <ul class="visible nav section-nav flex-column"> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#fill-null"> + fill_null + </a> + </li> + </ul> </li> </ul> @@ -505,16 +549,16 @@ <span class="o">+--------------------------------+</span> <span class="o">|</span> <span class="n">now</span><span class="p">()</span> <span class="o">|</span> <span class="o">+--------------------------------+</span> -<span class="o">|</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">03</span><span class="o">-</span><span class="mi">30</span><span class="n">T17</span><span class="p">:</span><span class="mi">49</span><span class="p">:</span><span class="mf">00.536576280</span><span class="n">Z</span> <span class="o">|</span> -<span class="o">|</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">03</span><span class="o">-</span><span class="mi">30</span><span class="n">T17</span><span class="p">:</span><span class="mi">49</span><span class="p">:</span><span class="mf">00.536576280</span><span class="n">Z</span> <span class="o">|</span> -<span class="o">|</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">03</span><span class="o">-</span><span class="mi">30</span><span class="n">T17</span><span class="p">:</span><span class="mi">49</span><span class="p">:</span><span class="mf">00.536576280</span><span class="n">Z</span> <span class="o">|</span> -<span class="o">|</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">03</span><span class="o">-</span><span class="mi">30</span><span class="n">T17</span><span class="p">:</span><span class="mi">49</span><span class="p">:</span><span class="mf">00.536576280</span><span class="n">Z</span> <span class="o">|</span> -<span class="o">|</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">03</span><span class="o">-</span><span class="mi">30</span><span class="n">T17</span><span class="p">:</span><span class="mi">49</span><span class="p">:</span><span class="mf">00.536576280</span><span class="n">Z</span> <span class="o">|</span> -<span class="o">|</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">03</span><span class="o">-</span><span class="mi">30</span><span class="n">T17</span><span class="p">:</span><span class="mi">49</span><span class="p">:</span><span class="mf">00.536576280</span><span class="n">Z</span> <span class="o">|</span> -<span class="o">|</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">03</span><span class="o">-</span><span class="mi">30</span><span class="n">T17</span><span class="p">:</span><span class="mi">49</span><span class="p">:</span><span class="mf">00.536576280</span><span class="n">Z</span> <span class="o">|</span> -<span class="o">|</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">03</span><span class="o">-</span><span class="mi">30</span><span class="n">T17</span><span class="p">:</span><span class="mi">49</span><span class="p">:</span><span class="mf">00.536576280</span><span class="n">Z</span> <span class="o">|</span> -<span class="o">|</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">03</span><span class="o">-</span><span class="mi">30</span><span class="n">T17</span><span class="p">:</span><span class="mi">49</span><span class="p">:</span><span class="mf">00.536576280</span><span class="n">Z</span> <span class="o">|</span> -<span class="o">|</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">03</span><span class="o">-</span><span class="mi">30</span><span class="n">T17</span><span class="p">:</span><span class="mi">49</span><span class="p">:</span><span class="mf">00.536576280</span><span class="n">Z</span> <span class="o">|</span> +<span class="o">|</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">28</span><span class="n">T18</span><span class="p">:</span><span class="mi">37</span><span class="p">:</span><span class="mf">38.343210340</span><span class="n">Z</span> <span class="o">|</span> +<span class="o">|</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">28</span><span class="n">T18</span><span class="p">:</span><span class="mi">37</span><span class="p">:</span><span class="mf">38.343210340</span><span class="n">Z</span> <span class="o">|</span> +<span class="o">|</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">28</span><span class="n">T18</span><span class="p">:</span><span class="mi">37</span><span class="p">:</span><span class="mf">38.343210340</span><span class="n">Z</span> <span class="o">|</span> +<span class="o">|</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">28</span><span class="n">T18</span><span class="p">:</span><span class="mi">37</span><span class="p">:</span><span class="mf">38.343210340</span><span class="n">Z</span> <span class="o">|</span> +<span class="o">|</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">28</span><span class="n">T18</span><span class="p">:</span><span class="mi">37</span><span class="p">:</span><span class="mf">38.343210340</span><span class="n">Z</span> <span class="o">|</span> +<span class="o">|</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">28</span><span class="n">T18</span><span class="p">:</span><span class="mi">37</span><span class="p">:</span><span class="mf">38.343210340</span><span class="n">Z</span> <span class="o">|</span> +<span class="o">|</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">28</span><span class="n">T18</span><span class="p">:</span><span class="mi">37</span><span class="p">:</span><span class="mf">38.343210340</span><span class="n">Z</span> <span class="o">|</span> +<span class="o">|</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">28</span><span class="n">T18</span><span class="p">:</span><span class="mi">37</span><span class="p">:</span><span class="mf">38.343210340</span><span class="n">Z</span> <span class="o">|</span> +<span class="o">|</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">28</span><span class="n">T18</span><span class="p">:</span><span class="mi">37</span><span class="p">:</span><span class="mf">38.343210340</span><span class="n">Z</span> <span class="o">|</span> +<span class="o">|</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">28</span><span class="n">T18</span><span class="p">:</span><span class="mi">37</span><span class="p">:</span><span class="mf">38.343210340</span><span class="n">Z</span> <span class="o">|</span> <span class="o">+--------------------------------+</span> <span class="n">Data</span> <span class="n">truncated</span><span class="o">.</span> </pre></div> @@ -686,6 +730,22 @@ </div> </section> </section> +<section id="handling-missing-values"> +<h1>Handling Missing Values<a class="headerlink" href="#handling-missing-values" title="Link to this heading">¶</a></h1> +<p>DataFusion provides methods to handle missing values in DataFrames:</p> +<section id="fill-null"> +<h2>fill_null<a class="headerlink" href="#fill-null" title="Link to this heading">¶</a></h2> +<p>The <code class="docutils literal notranslate"><span class="pre">fill_null()</span></code> method replaces NULL values in specified columns with a provided value:</p> +<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Fill all NULL values with 0 where possible</span> +<span class="n">df</span> <span class="o">=</span> <span class="n">df</span><span class="o">.</span><span class="n">fill_null</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> + +<span class="c1"># Fill NULL values only in specific string columns</span> +<span class="n">df</span> <span class="o">=</span> <span class="n">df</span><span class="o">.</span><span class="n">fill_null</span><span class="p">(</span><span class="s2">"missing"</span><span class="p">,</span> <span class="n">subset</span><span class="o">=</span><span class="p">[</span><span class="s2">"name"</span><span class="p">,</span> <span class="s2">"category"</span><span class="p">])</span> +</pre></div> +</div> +<p>The fill value will be cast to match each column’s type. If casting fails for a column, that column remains unchanged.</p> +</section> +</section> </div>
diff --git a/user-guide/common-operations/index.html b/user-guide/common-operations/index.html index a8f5abc..af2c61f 100644 --- a/user-guide/common-operations/index.html +++ b/user-guide/common-operations/index.html
@@ -35,7 +35,7 @@ <link rel="index" title="Index" href="../../genindex.html" /> <link rel="search" title="Search" href="../../search.html" /> <link rel="next" title="Registering Views" href="views.html" /> - <link rel="prev" title="Data Sources" href="../data-sources.html" /> + <link rel="prev" title="DataFrames" href="../dataframe.html" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="docsearch:language" content="en"> @@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 current active has-children"> <a class="current reference internal" href="#"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul> @@ -425,6 +450,10 @@ <li class="toctree-l2"><a class="reference internal" href="functions.html#other">Other</a></li> </ul> </li> +<li class="toctree-l1"><a class="reference internal" href="functions.html#handling-missing-values">Handling Missing Values</a><ul> +<li class="toctree-l2"><a class="reference internal" href="functions.html#fill-null">fill_null</a></li> +</ul> +</li> <li class="toctree-l1"><a class="reference internal" href="aggregations.html">Aggregation</a><ul> <li class="toctree-l2"><a class="reference internal" href="aggregations.html#setting-parameters">Setting Parameters</a></li> <li class="toctree-l2"><a class="reference internal" href="aggregations.html#aggregate-functions">Aggregate Functions</a></li> @@ -440,6 +469,7 @@ <li class="toctree-l2"><a class="reference internal" href="udf-and-udfa.html#scalar-functions">Scalar Functions</a></li> <li class="toctree-l2"><a class="reference internal" href="udf-and-udfa.html#aggregate-functions">Aggregate Functions</a></li> <li class="toctree-l2"><a class="reference internal" href="udf-and-udfa.html#window-functions">Window Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="udf-and-udfa.html#table-functions">Table Functions</a></li> </ul> </li> </ul> @@ -452,11 +482,11 @@ <!-- Previous / next buttons --> <div class='prev-next-area'> - <a class='left-prev' id="prev-link" href="../data-sources.html" title="previous page"> + <a class='left-prev' id="prev-link" href="../dataframe.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> - <p class="prev-next-title">Data Sources</p> + <p class="prev-next-title">DataFrames</p> </div> </a> <a class='right-next' id="next-link" href="views.html" title="next page">
diff --git a/user-guide/common-operations/joins.html b/user-guide/common-operations/joins.html index 880447f..3dc6557 100644 --- a/user-guide/common-operations/joins.html +++ b/user-guide/common-operations/joins.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/user-guide/common-operations/select-and-filter.html b/user-guide/common-operations/select-and-filter.html index 1a01824..29f8d8a 100644 --- a/user-guide/common-operations/select-and-filter.html +++ b/user-guide/common-operations/select-and-filter.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/user-guide/common-operations/udf-and-udfa.html b/user-guide/common-operations/udf-and-udfa.html index 92d9457..a5edf50 100644 --- a/user-guide/common-operations/udf-and-udfa.html +++ b/user-guide/common-operations/udf-and-udfa.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul> @@ -397,6 +422,11 @@ </li> </ul> </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#table-functions"> + Table Functions + </a> + </li> </ul> </nav> @@ -426,7 +456,7 @@ <h2>Scalar Functions<a class="headerlink" href="#scalar-functions" title="Link to this heading">¶</a></h2> <p>When writing a user-defined function that can operate on a row by row basis, these are called Scalar Functions. You can define your own scalar function by calling -<a class="reference internal" href="../../autoapi/datafusion/udf/index.html#datafusion.udf.ScalarUDF.udf" title="datafusion.udf.ScalarUDF.udf"><code class="xref py py-func docutils literal notranslate"><span class="pre">udf()</span></code></a> .</p> +<a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html#datafusion.user_defined.ScalarUDF.udf" title="datafusion.user_defined.ScalarUDF.udf"><code class="xref py py-func docutils literal notranslate"><span class="pre">udf()</span></code></a> .</p> <p>The basic definition of a scalar UDF is a python function that takes one or more <a class="reference external" href="https://arrow.apache.org/docs/python/index.html">pyarrow</a> arrays and returns a single array as output. DataFusion scalar UDFs operate on an entire batch of records at a time, though the @@ -512,9 +542,9 @@ </section> <section id="aggregate-functions"> <h2>Aggregate Functions<a class="headerlink" href="#aggregate-functions" title="Link to this heading">¶</a></h2> -<p>The <a class="reference internal" href="../../autoapi/datafusion/udf/index.html#datafusion.udf.AggregateUDF.udaf" title="datafusion.udf.AggregateUDF.udaf"><code class="xref py py-func docutils literal notranslate"><span class="pre">udaf()</span></code></a> function allows you to define User-Defined +<p>The <a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html#datafusion.user_defined.AggregateUDF.udaf" title="datafusion.user_defined.AggregateUDF.udaf"><code class="xref py py-func docutils literal notranslate"><span class="pre">udaf()</span></code></a> function allows you to define User-Defined Aggregate Functions (UDAFs). To use this you must implement an -<a class="reference internal" href="../../autoapi/datafusion/udf/index.html#datafusion.udf.Accumulator" title="datafusion.udf.Accumulator"><code class="xref py py-class docutils literal notranslate"><span class="pre">Accumulator</span></code></a> that determines how the aggregation is performed.</p> +<a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html#datafusion.user_defined.Accumulator" title="datafusion.user_defined.Accumulator"><code class="xref py py-class docutils literal notranslate"><span class="pre">Accumulator</span></code></a> that determines how the aggregation is performed.</p> <p>When defining a UDAF there are four methods you need to implement. The <code class="docutils literal notranslate"><span class="pre">update</span></code> function takes the array(s) of input and updates the internal state of the accumulator. You should define this function to have as many input arguments as you will pass when calling the UDAF. Since aggregation may be @@ -568,8 +598,8 @@ <section id="window-functions"> <h2>Window Functions<a class="headerlink" href="#window-functions" title="Link to this heading">¶</a></h2> <p>To implement a User-Defined Window Function (UDWF) you must call the -<a class="reference internal" href="../../autoapi/datafusion/udf/index.html#datafusion.udf.WindowUDF.udwf" title="datafusion.udf.WindowUDF.udwf"><code class="xref py py-func docutils literal notranslate"><span class="pre">udwf()</span></code></a> function using a class that implements the abstract -class <a class="reference internal" href="../../autoapi/datafusion/udf/index.html#datafusion.udf.WindowEvaluator" title="datafusion.udf.WindowEvaluator"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowEvaluator</span></code></a>.</p> +<a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html#datafusion.user_defined.WindowUDF.udwf" title="datafusion.user_defined.WindowUDF.udwf"><code class="xref py py-func docutils literal notranslate"><span class="pre">udwf()</span></code></a> function using a class that implements the abstract +class <a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html#datafusion.user_defined.WindowEvaluator" title="datafusion.user_defined.WindowEvaluator"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowEvaluator</span></code></a>.</p> <p>There are three methods of evaluation of UDWFs.</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">evaluate</span></code> is the simplest case, where you are given an array and are expected to calculate the @@ -623,7 +653,7 @@ </ul> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">pyarrow</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">pa</span> <span class="kn">from</span><span class="w"> </span><span class="nn">datafusion</span><span class="w"> </span><span class="kn">import</span> <span class="n">udwf</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">SessionContext</span> -<span class="kn">from</span><span class="w"> </span><span class="nn">datafusion.udf</span><span class="w"> </span><span class="kn">import</span> <span class="n">WindowEvaluator</span> +<span class="kn">from</span><span class="w"> </span><span class="nn">datafusion.user_defined</span><span class="w"> </span><span class="kn">import</span> <span class="n">WindowEvaluator</span> <span class="k">class</span><span class="w"> </span><span class="nc">ExponentialSmooth</span><span class="p">(</span><span class="n">WindowEvaluator</span><span class="p">):</span> <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">alpha</span><span class="p">:</span> <span class="nb">float</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> @@ -662,6 +692,34 @@ </div> </section> </section> +<section id="table-functions"> +<h2>Table Functions<a class="headerlink" href="#table-functions" title="Link to this heading">¶</a></h2> +<p>User Defined Table Functions are slightly different than the other functions +described here. These functions take any number of <cite>Expr</cite> arguments, but only +literal expressions are supported. Table functions must return a Table +Provider as described in the ref:<cite>_io_custom_table_provider</cite> page.</p> +<p>Once you have a table function, you can register it with the session context +by using <a class="reference internal" href="../../autoapi/datafusion/context/index.html#datafusion.context.SessionContext.register_udtf" title="datafusion.context.SessionContext.register_udtf"><code class="xref py py-func docutils literal notranslate"><span class="pre">datafusion.context.SessionContext.register_udtf()</span></code></a>.</p> +<p>There are examples of both rust backed and python based table functions in the +examples folder of the repository. If you have a rust backed table function +that you wish to expose via PyO3, you need to expose it as a <code class="docutils literal notranslate"><span class="pre">PyCapsule</span></code>.</p> +<div class="highlight-rust notranslate"><div class="highlight"><pre><span></span><span class="cp">#[pymethods]</span> +<span class="k">impl</span><span class="w"> </span><span class="n">MyTableFunction</span><span class="w"> </span><span class="p">{</span> +<span class="w"> </span><span class="k">fn</span><span class="w"> </span><span class="nf">__datafusion_table_function__</span><span class="o"><'</span><span class="na">py</span><span class="o">></span><span class="p">(</span> +<span class="w"> </span><span class="o">&</span><span class="bp">self</span><span class="p">,</span> +<span class="w"> </span><span class="n">py</span><span class="p">:</span><span class="w"> </span><span class="nc">Python</span><span class="o"><'</span><span class="na">py</span><span class="o">></span><span class="p">,</span> +<span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">-></span><span class="w"> </span><span class="nc">PyResult</span><span class="o"><</span><span class="n">Bound</span><span class="o"><'</span><span class="na">py</span><span class="p">,</span><span class="w"> </span><span class="n">PyCapsule</span><span class="o">>></span><span class="w"> </span><span class="p">{</span> +<span class="w"> </span><span class="kd">let</span><span class="w"> </span><span class="n">name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">cr</span><span class="s">"datafusion_table_function"</span><span class="p">.</span><span class="n">into</span><span class="p">();</span> + +<span class="w"> </span><span class="kd">let</span><span class="w"> </span><span class="n">func</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="bp">self</span><span class="p">.</span><span class="n">clone</span><span class="p">();</span> +<span class="w"> </span><span class="kd">let</span><span class="w"> </span><span class="n">provider</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">FFI_TableFunction</span><span class="p">::</span><span class="n">new</span><span class="p">(</span><span class="n">Arc</span><span class="p">::</span><span class="n">new</span><span class="p">(</span><span class="n">func</span><span class="p">),</span><span class="w"> </span><span class="nb">None</span><span class="p">);</span> + +<span class="w"> </span><span class="n">PyCapsule</span><span class="p">::</span><span class="n">new</span><span class="p">(</span><span class="n">py</span><span class="p">,</span><span class="w"> </span><span class="n">provider</span><span class="p">,</span><span class="w"> </span><span class="nb">Some</span><span class="p">(</span><span class="n">name</span><span class="p">))</span> +<span class="w"> </span><span class="p">}</span> +<span class="p">}</span> +</pre></div> +</div> +</section> </section>
diff --git a/user-guide/common-operations/views.html b/user-guide/common-operations/views.html index 0ffc23d..be6a958 100644 --- a/user-guide/common-operations/views.html +++ b/user-guide/common-operations/views.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/user-guide/common-operations/windows.html b/user-guide/common-operations/windows.html index 4b2be12..dcd5e50 100644 --- a/user-guide/common-operations/windows.html +++ b/user-guide/common-operations/windows.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/user-guide/configuration.html b/user-guide/configuration.html index b29bfff..5cd4597 100644 --- a/user-guide/configuration.html +++ b/user-guide/configuration.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/user-guide/data-sources.html b/user-guide/data-sources.html index 64be39f..f1be589 100644 --- a/user-guide/data-sources.html +++ b/user-guide/data-sources.html
@@ -34,7 +34,7 @@ <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> - <link rel="next" title="Common Operations" href="common-operations/index.html" /> + <link rel="next" title="DataFrames" href="dataframe.html" /> <link rel="prev" title="Concepts" href="basics.html" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="docsearch:language" content="en"> @@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul> @@ -650,10 +675,10 @@ <p class="prev-next-title">Concepts</p> </div> </a> - <a class='right-next' id="next-link" href="common-operations/index.html" title="next page"> + <a class='right-next' id="next-link" href="dataframe.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> - <p class="prev-next-title">Common Operations</p> + <p class="prev-next-title">DataFrames</p> </div> <i class="fas fa-angle-right"></i> </a>
diff --git a/user-guide/dataframe.html b/user-guide/dataframe.html new file mode 100644 index 0000000..2c27110 --- /dev/null +++ b/user-guide/dataframe.html
@@ -0,0 +1,705 @@ +<!DOCTYPE html> + +<html lang="en" data-content_root="../"> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> + + <title>DataFrames — Apache Arrow DataFusion documentation</title> + + <link href="../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> +<link href="../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> + + + <link rel="stylesheet" + href="../_static/vendor/fontawesome/5.13.0/css/all.min.css"> + <link rel="preload" as="font" type="font/woff2" crossorigin + href="../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> + <link rel="preload" as="font" type="font/woff2" crossorigin + href="../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> + + + + + + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> + <link rel="stylesheet" type="text/css" href="../_static/styles/pydata-sphinx-theme.css?v=1140d252" /> + <link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=4ae1632d" /> + <link rel="stylesheet" type="text/css" href="../_static/theme_overrides.css?v=dca7052a" /> + + <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> + + <script src="../_static/documentation_options.js?v=8a448e45"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> + <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="Common Operations" href="common-operations/index.html" /> + <link rel="prev" title="Data Sources" href="data-sources.html" /> + <meta name="viewport" content="width=device-width, initial-scale=1" /> + <meta name="docsearch:language" content="en"> + + + <!-- Google Analytics --> + + </head> + <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80"> + + <div class="container-fluid" id="banner"></div> + + + + + <div class="container-xl"> + <div class="row"> + + + <!-- Only show if we have sidebars configured, else just a small margin --> + <div class="col-12 col-md-3 bd-sidebar"> + <div class="sidebar-start-items"> +<a class="navbar-brand" href="../index.html"> + <img src="../_static/images/2x_bgwhite_original.png" class="logo" alt="logo"> +</a> + +<form class="bd-search d-flex align-items-center" action="../search.html" method="get"> + <i class="icon fas fa-search"></i> + <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" > +</form> + +<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation"> + <div class="bd-toc-item active"> + + <p aria-level="2" class="caption" role="heading"> + <span class="caption-text"> + LINKS + </span> +</p> +<ul class="nav bd-sidenav"> + <li class="toctree-l1"> + <a class="reference external" href="https://github.com/apache/datafusion-python"> + Github and Issue Tracker + </a> + </li> + <li class="toctree-l1"> + <a class="reference external" href="https://docs.rs/datafusion/latest/datafusion/"> + Rust's API Docs + </a> + </li> + <li class="toctree-l1"> + <a class="reference external" href="https://github.com/apache/datafusion/blob/main/CODE_OF_CONDUCT.md"> + Code of conduct + </a> + </li> + <li class="toctree-l1"> + <a class="reference external" href="https://github.com/apache/datafusion-python/tree/main/examples"> + Examples + </a> + </li> +</ul> +<p aria-level="2" class="caption" role="heading"> + <span class="caption-text"> + USER GUIDE + </span> +</p> +<ul class="current nav bd-sidenav"> + <li class="toctree-l1"> + <a class="reference internal" href="introduction.html"> + Introduction + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="basics.html"> + Concepts + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="data-sources.html"> + Data Sources + </a> + </li> + <li class="toctree-l1 current active"> + <a class="current reference internal" href="#"> + DataFrames + </a> + </li> + <li class="toctree-l1 has-children"> + <a class="reference internal" href="common-operations/index.html"> + Common Operations + </a> + <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/> + <label for="toctree-checkbox-1"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul> + <li class="toctree-l2"> + <a class="reference internal" href="common-operations/views.html"> + Registering Views + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="common-operations/basic-info.html"> + Basic Operations + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="common-operations/select-and-filter.html"> + Column Selections + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="common-operations/expressions.html"> + Expressions + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="common-operations/joins.html"> + Joins + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="common-operations/functions.html"> + Functions + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="common-operations/aggregations.html"> + Aggregation + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="common-operations/windows.html"> + Window Functions + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="common-operations/udf-and-udfa.html"> + User-Defined Functions + </a> + </li> + </ul> + </li> + <li class="toctree-l1 has-children"> + <a class="reference internal" href="io/index.html"> + IO + </a> + <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/> + <label for="toctree-checkbox-2"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul> + <li class="toctree-l2"> + <a class="reference internal" href="io/arrow.html"> + Arrow + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="io/avro.html"> + Avro + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="io/csv.html"> + CSV + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="io/json.html"> + JSON + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="io/parquet.html"> + Parquet + </a> + </li> + <li class="toctree-l2"> + <a class="reference internal" href="io/table_provider.html"> + Custom Table Provider + </a> + </li> + </ul> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="configuration.html"> + Configuration + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="sql.html"> + SQL + </a> + </li> +</ul> +<p aria-level="2" class="caption" role="heading"> + <span class="caption-text"> + CONTRIBUTOR GUIDE + </span> +</p> +<ul class="nav bd-sidenav"> + <li class="toctree-l1"> + <a class="reference internal" href="../contributor-guide/introduction.html"> + Introduction + </a> + </li> + <li class="toctree-l1"> + <a class="reference internal" href="../contributor-guide/ffi.html"> + Python Extensions + </a> + </li> +</ul> +<p aria-level="2" class="caption" role="heading"> + <span class="caption-text"> + API + </span> +</p> +<ul class="nav bd-sidenav"> + <li class="toctree-l1 has-children"> + <a class="reference internal" href="../autoapi/index.html"> + API Reference + </a> + <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/> + <label for="toctree-checkbox-3"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul> + <li class="toctree-l2 has-children"> + <a class="reference internal" href="../autoapi/datafusion/index.html"> + datafusion + </a> + <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/> + <label for="toctree-checkbox-4"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/catalog/index.html"> + datafusion.catalog + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/context/index.html"> + datafusion.context + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/dataframe/index.html"> + datafusion.dataframe + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/expr/index.html"> + datafusion.expr + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/functions/index.html"> + datafusion.functions + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> + <li class="toctree-l3 has-children"> + <a class="reference internal" href="../autoapi/datafusion/input/index.html"> + datafusion.input + </a> + <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/> + <label for="toctree-checkbox-5"> + <i class="fas fa-chevron-down"> + </i> + </label> + <ul> + <li class="toctree-l4"> + <a class="reference internal" href="../autoapi/datafusion/input/base/index.html"> + datafusion.input.base + </a> + </li> + <li class="toctree-l4"> + <a class="reference internal" href="../autoapi/datafusion/input/location/index.html"> + datafusion.input.location + </a> + </li> + </ul> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/io/index.html"> + datafusion.io + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/object_store/index.html"> + datafusion.object_store + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/plan/index.html"> + datafusion.plan + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/record_batch/index.html"> + datafusion.record_batch + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/substrait/index.html"> + datafusion.substrait + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/udf/index.html"> + datafusion.udf + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> + </ul> + </li> + </ul> + </li> +</ul> + + + </div> +</nav> + </div> + <div class="sidebar-end-items"> + </div> + </div> + + + + + <div class="d-none d-xl-block col-xl-2 bd-toc"> + + + <div class="toc-item"> + +<div class="tocsection onthispage pt-5 pb-3"> + <i class="fas fa-list"></i> On this page +</div> + +<nav id="bd-toc-nav"> + <ul class="visible nav section-nav flex-column"> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#overview"> + Overview + </a> + </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#basic-usage"> + Basic Usage + </a> + </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#html-rendering"> + HTML Rendering + </a> + </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#customizing-html-rendering"> + Customizing HTML Rendering + </a> + </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#custom-style-providers"> + Custom Style Providers + </a> + </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#performance-optimization-with-shared-styles"> + Performance Optimization with Shared Styles + </a> + </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#creating-a-custom-formatter"> + Creating a Custom Formatter + </a> + </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#managing-formatters"> + Managing Formatters + </a> + </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#contextual-formatting"> + Contextual Formatting + </a> + </li> + <li class="toc-h2 nav-item toc-entry"> + <a class="reference internal nav-link" href="#memory-and-display-controls"> + Memory and Display Controls + </a> + </li> +</ul> + +</nav> + </div> + + <div class="toc-item"> + + </div> + + + </div> + + + + + + + <main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main"> + + <div> + + <section id="dataframes"> +<h1>DataFrames<a class="headerlink" href="#dataframes" title="Link to this heading">¶</a></h1> +<section id="overview"> +<h2>Overview<a class="headerlink" href="#overview" title="Link to this heading">¶</a></h2> +<p>DataFusion’s DataFrame API provides a powerful interface for building and executing queries against data sources. +It offers a familiar API similar to pandas and other DataFrame libraries, but with the performance benefits of Rust +and Arrow.</p> +<p>A DataFrame represents a logical plan that can be composed through operations like filtering, projection, and aggregation. +The actual execution happens when terminal operations like <code class="docutils literal notranslate"><span class="pre">collect()</span></code> or <code class="docutils literal notranslate"><span class="pre">show()</span></code> are called.</p> +</section> +<section id="basic-usage"> +<h2>Basic Usage<a class="headerlink" href="#basic-usage" title="Link to this heading">¶</a></h2> +<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">datafusion</span> +<span class="kn">from</span><span class="w"> </span><span class="nn">datafusion</span><span class="w"> </span><span class="kn">import</span> <span class="n">col</span><span class="p">,</span> <span class="n">lit</span> + +<span class="c1"># Create a context and register a data source</span> +<span class="n">ctx</span> <span class="o">=</span> <span class="n">datafusion</span><span class="o">.</span><span class="n">SessionContext</span><span class="p">()</span> +<span class="n">ctx</span><span class="o">.</span><span class="n">register_csv</span><span class="p">(</span><span class="s2">"my_table"</span><span class="p">,</span> <span class="s2">"path/to/data.csv"</span><span class="p">)</span> + +<span class="c1"># Create and manipulate a DataFrame</span> +<span class="n">df</span> <span class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s2">"SELECT * FROM my_table"</span><span class="p">)</span> + +<span class="c1"># Or use the DataFrame API directly</span> +<span class="n">df</span> <span class="o">=</span> <span class="p">(</span><span class="n">ctx</span><span class="o">.</span><span class="n">table</span><span class="p">(</span><span class="s2">"my_table"</span><span class="p">)</span> + <span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">col</span><span class="p">(</span><span class="s2">"age"</span><span class="p">)</span> <span class="o">></span> <span class="n">lit</span><span class="p">(</span><span class="mi">25</span><span class="p">))</span> + <span class="o">.</span><span class="n">select</span><span class="p">([</span><span class="n">col</span><span class="p">(</span><span class="s2">"name"</span><span class="p">),</span> <span class="n">col</span><span class="p">(</span><span class="s2">"age"</span><span class="p">)]))</span> + +<span class="c1"># Execute and collect results</span> +<span class="n">result</span> <span class="o">=</span> <span class="n">df</span><span class="o">.</span><span class="n">collect</span><span class="p">()</span> + +<span class="c1"># Display the first few rows</span> +<span class="n">df</span><span class="o">.</span><span class="n">show</span><span class="p">()</span> +</pre></div> +</div> +</section> +<section id="html-rendering"> +<h2>HTML Rendering<a class="headerlink" href="#html-rendering" title="Link to this heading">¶</a></h2> +<p>When working in Jupyter notebooks or other environments that support HTML rendering, DataFrames will +automatically display as formatted HTML tables, making it easier to visualize your data.</p> +<p>The <code class="docutils literal notranslate"><span class="pre">_repr_html_</span></code> method is called automatically by Jupyter to render a DataFrame. This method +controls how DataFrames appear in notebook environments, providing a richer visualization than +plain text output.</p> +</section> +<section id="customizing-html-rendering"> +<h2>Customizing HTML Rendering<a class="headerlink" href="#customizing-html-rendering" title="Link to this heading">¶</a></h2> +<p>You can customize how DataFrames are rendered in HTML by configuring the formatter:</p> +<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">datafusion.html_formatter</span><span class="w"> </span><span class="kn">import</span> <span class="n">configure_formatter</span> + +<span class="c1"># Change the default styling</span> +<span class="n">configure_formatter</span><span class="p">(</span> + <span class="n">max_cell_length</span><span class="o">=</span><span class="mi">25</span><span class="p">,</span> <span class="c1"># Maximum characters in a cell before truncation</span> + <span class="n">max_width</span><span class="o">=</span><span class="mi">1000</span><span class="p">,</span> <span class="c1"># Maximum width in pixels</span> + <span class="n">max_height</span><span class="o">=</span><span class="mi">300</span><span class="p">,</span> <span class="c1"># Maximum height in pixels</span> + <span class="n">max_memory_bytes</span><span class="o">=</span><span class="mi">2097152</span><span class="p">,</span> <span class="c1"># Maximum memory for rendering (2MB)</span> + <span class="n">min_rows_display</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span> <span class="c1"># Minimum number of rows to display</span> + <span class="n">repr_rows</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="c1"># Number of rows to display in __repr__</span> + <span class="n">enable_cell_expansion</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span><span class="c1"># Allow expanding truncated cells</span> + <span class="n">custom_css</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># Additional custom CSS</span> + <span class="n">show_truncation_message</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="c1"># Show message when data is truncated</span> + <span class="n">style_provider</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># Custom styling provider</span> + <span class="n">use_shared_styles</span><span class="o">=</span><span class="kc">True</span> <span class="c1"># Share styles across tables</span> +<span class="p">)</span> +</pre></div> +</div> +<p>The formatter settings affect all DataFrames displayed after configuration.</p> +</section> +<section id="custom-style-providers"> +<h2>Custom Style Providers<a class="headerlink" href="#custom-style-providers" title="Link to this heading">¶</a></h2> +<p>For advanced styling needs, you can create a custom style provider:</p> +<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">datafusion.html_formatter</span><span class="w"> </span><span class="kn">import</span> <span class="n">StyleProvider</span><span class="p">,</span> <span class="n">configure_formatter</span> + +<span class="k">class</span><span class="w"> </span><span class="nc">MyStyleProvider</span><span class="p">(</span><span class="n">StyleProvider</span><span class="p">):</span> + <span class="k">def</span><span class="w"> </span><span class="nf">get_table_styles</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="k">return</span> <span class="p">{</span> + <span class="s2">"table"</span><span class="p">:</span> <span class="s2">"border-collapse: collapse; width: 100%;"</span><span class="p">,</span> + <span class="s2">"th"</span><span class="p">:</span> <span class="s2">"background-color: #007bff; color: white; padding: 8px; text-align: left;"</span><span class="p">,</span> + <span class="s2">"td"</span><span class="p">:</span> <span class="s2">"border: 1px solid #ddd; padding: 8px;"</span><span class="p">,</span> + <span class="s2">"tr:nth-child(even)"</span><span class="p">:</span> <span class="s2">"background-color: #f2f2f2;"</span><span class="p">,</span> + <span class="p">}</span> + + <span class="k">def</span><span class="w"> </span><span class="nf">get_value_styles</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dtype</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> +<span class="w"> </span><span class="sd">"""Return custom styles for specific values"""</span> + <span class="k">if</span> <span class="n">dtype</span> <span class="o">==</span> <span class="s2">"float"</span> <span class="ow">and</span> <span class="n">value</span> <span class="o"><</span> <span class="mi">0</span><span class="p">:</span> + <span class="k">return</span> <span class="s2">"color: red;"</span> + <span class="k">return</span> <span class="kc">None</span> + +<span class="c1"># Apply the custom style provider</span> +<span class="n">configure_formatter</span><span class="p">(</span><span class="n">style_provider</span><span class="o">=</span><span class="n">MyStyleProvider</span><span class="p">())</span> +</pre></div> +</div> +</section> +<section id="performance-optimization-with-shared-styles"> +<h2>Performance Optimization with Shared Styles<a class="headerlink" href="#performance-optimization-with-shared-styles" title="Link to this heading">¶</a></h2> +<p>The <code class="docutils literal notranslate"><span class="pre">use_shared_styles</span></code> parameter (enabled by default) optimizes performance when displaying +multiple DataFrames in notebook environments:</p> +<blockquote> +<div></div></blockquote> +<p>When <code class="docutils literal notranslate"><span class="pre">use_shared_styles=True</span></code>: +- CSS styles and JavaScript are included only once per notebook session +- This reduces HTML output size and prevents style duplication +- Improves rendering performance with many DataFrames +- Applies consistent styling across all DataFrames</p> +</section> +<section id="creating-a-custom-formatter"> +<h2>Creating a Custom Formatter<a class="headerlink" href="#creating-a-custom-formatter" title="Link to this heading">¶</a></h2> +<p>For complete control over rendering, you can implement a custom formatter:</p> +<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">datafusion.html_formatter</span><span class="w"> </span><span class="kn">import</span> <span class="n">Formatter</span><span class="p">,</span> <span class="n">get_formatter</span> + +<span class="k">class</span><span class="w"> </span><span class="nc">MyFormatter</span><span class="p">(</span><span class="n">Formatter</span><span class="p">):</span> + <span class="k">def</span><span class="w"> </span><span class="nf">format_html</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">batches</span><span class="p">,</span> <span class="n">schema</span><span class="p">,</span> <span class="n">has_more</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">table_uuid</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> + <span class="c1"># Create your custom HTML here</span> + <span class="n">html</span> <span class="o">=</span> <span class="s2">"<div class='my-custom-table'>"</span> + <span class="c1"># ... formatting logic ...</span> + <span class="n">html</span> <span class="o">+=</span> <span class="s2">"</div>"</span> + <span class="k">return</span> <span class="n">html</span> + +<span class="c1"># Set as the global formatter</span> +<span class="n">configure_formatter</span><span class="p">(</span><span class="n">formatter_class</span><span class="o">=</span><span class="n">MyFormatter</span><span class="p">)</span> + +<span class="c1"># Or use the formatter just for specific operations</span> +<span class="n">formatter</span> <span class="o">=</span> <span class="n">get_formatter</span><span class="p">()</span> +<span class="n">custom_html</span> <span class="o">=</span> <span class="n">formatter</span><span class="o">.</span><span class="n">format_html</span><span class="p">(</span><span class="n">batches</span><span class="p">,</span> <span class="n">schema</span><span class="p">)</span> +</pre></div> +</div> +</section> +<section id="managing-formatters"> +<h2>Managing Formatters<a class="headerlink" href="#managing-formatters" title="Link to this heading">¶</a></h2> +<p>Reset to default formatting:</p> +<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">datafusion.html_formatter</span><span class="w"> </span><span class="kn">import</span> <span class="n">reset_formatter</span> + +<span class="c1"># Reset to default settings</span> +<span class="n">reset_formatter</span><span class="p">()</span> +</pre></div> +</div> +<p>Get the current formatter settings:</p> +<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">datafusion.html_formatter</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_formatter</span> + +<span class="n">formatter</span> <span class="o">=</span> <span class="n">get_formatter</span><span class="p">()</span> +<span class="nb">print</span><span class="p">(</span><span class="n">formatter</span><span class="o">.</span><span class="n">max_rows</span><span class="p">)</span> +<span class="nb">print</span><span class="p">(</span><span class="n">formatter</span><span class="o">.</span><span class="n">theme</span><span class="p">)</span> +</pre></div> +</div> +</section> +<section id="contextual-formatting"> +<h2>Contextual Formatting<a class="headerlink" href="#contextual-formatting" title="Link to this heading">¶</a></h2> +<p>You can also use a context manager to temporarily change formatting settings:</p> +<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">datafusion.html_formatter</span><span class="w"> </span><span class="kn">import</span> <span class="n">formatting_context</span> + +<span class="c1"># Default formatting</span> +<span class="n">df</span><span class="o">.</span><span class="n">show</span><span class="p">()</span> + +<span class="c1"># Temporarily use different formatting</span> +<span class="k">with</span> <span class="n">formatting_context</span><span class="p">(</span><span class="n">max_rows</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">theme</span><span class="o">=</span><span class="s2">"dark"</span><span class="p">):</span> + <span class="n">df</span><span class="o">.</span><span class="n">show</span><span class="p">()</span> <span class="c1"># Will use the temporary settings</span> + +<span class="c1"># Back to default formatting</span> +<span class="n">df</span><span class="o">.</span><span class="n">show</span><span class="p">()</span> +</pre></div> +</div> +</section> +<section id="memory-and-display-controls"> +<h2>Memory and Display Controls<a class="headerlink" href="#memory-and-display-controls" title="Link to this heading">¶</a></h2> +<p>You can control how much data is displayed and how much memory is used for rendering:</p> +<blockquote> +<div><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">configure_formatter</span><span class="p">(</span> + <span class="n">max_memory_bytes</span><span class="o">=</span><span class="mi">4</span> <span class="o">*</span> <span class="mi">1024</span> <span class="o">*</span> <span class="mi">1024</span><span class="p">,</span> <span class="c1"># 4MB maximum memory for display</span> + <span class="n">min_rows_display</span><span class="o">=</span><span class="mi">50</span><span class="p">,</span> <span class="c1"># Always show at least 50 rows</span> + <span class="n">repr_rows</span><span class="o">=</span><span class="mi">20</span> <span class="c1"># Show 20 rows in __repr__ output</span> +<span class="p">)</span> +</pre></div> +</div> +</div></blockquote> +<p>These parameters help balance comprehensive data display against performance considerations.</p> +</section> +</section> + + + </div> + + + <!-- Previous / next buttons --> +<div class='prev-next-area'> + <a class='left-prev' id="prev-link" href="data-sources.html" title="previous page"> + <i class="fas fa-angle-left"></i> + <div class="prev-next-info"> + <p class="prev-next-subtitle">previous</p> + <p class="prev-next-title">Data Sources</p> + </div> + </a> + <a class='right-next' id="next-link" href="common-operations/index.html" title="next page"> + <div class="prev-next-info"> + <p class="prev-next-subtitle">next</p> + <p class="prev-next-title">Common Operations</p> + </div> + <i class="fas fa-angle-right"></i> + </a> +</div> + + </main> + + + </div> + </div> + + <script src="../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> + +<!-- Based on pydata_sphinx_theme/footer.html --> +<footer class="footer mt-5 mt-md-0"> + <div class="container"> + + <div class="footer-item"> + <p class="copyright"> + © Copyright 2019-2024, Apache Software Foundation.<br> +</p> + </div> + + <div class="footer-item"> + <p class="sphinx-version"> +Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.1.3.<br> +</p> + </div> + + <div class="footer-item"> + <p>Apache Arrow DataFusion, Arrow DataFusion, Apache, the Apache feather logo, and the Apache Arrow DataFusion project logo</p> + <p>are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.</p> + </div> + </div> +</footer> + + + </body> +</html> \ No newline at end of file
diff --git a/user-guide/introduction.html b/user-guide/introduction.html index 64f7137..70d4f4a 100644 --- a/user-guide/introduction.html +++ b/user-guide/introduction.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul> @@ -415,7 +440,7 @@ <div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="n">In</span> <span class="p">[</span><span class="mi">1</span><span class="p">]:</span> <span class="kn">import</span><span class="w"> </span><span class="nn">datafusion</span> <span class="n">In</span> <span class="p">[</span><span class="mi">2</span><span class="p">]:</span> <span class="n">datafusion</span><span class="o">.</span><span class="n">__version__</span> -<span class="n">Out</span><span class="p">[</span><span class="mi">2</span><span class="p">]:</span> <span class="s1">'46.0.0'</span> +<span class="n">Out</span><span class="p">[</span><span class="mi">2</span><span class="p">]:</span> <span class="s1">'47.0.0'</span> </pre></div> </div> <p>In this documentation we will also show some examples for how DataFusion integrates
diff --git a/user-guide/io/arrow.html b/user-guide/io/arrow.html index caa0e63..7abc1d4 100644 --- a/user-guide/io/arrow.html +++ b/user-guide/io/arrow.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/user-guide/io/avro.html b/user-guide/io/avro.html index 9c18f51..11306da 100644 --- a/user-guide/io/avro.html +++ b/user-guide/io/avro.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/user-guide/io/csv.html b/user-guide/io/csv.html index 880ce77..c07f778 100644 --- a/user-guide/io/csv.html +++ b/user-guide/io/csv.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/user-guide/io/index.html b/user-guide/io/index.html index b42512d..b2bfcab 100644 --- a/user-guide/io/index.html +++ b/user-guide/io/index.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/user-guide/io/json.html b/user-guide/io/json.html index 52d5377..627d486 100644 --- a/user-guide/io/json.html +++ b/user-guide/io/json.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/user-guide/io/parquet.html b/user-guide/io/parquet.html index 71d0338..168fd01 100644 --- a/user-guide/io/parquet.html +++ b/user-guide/io/parquet.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/user-guide/io/table_provider.html b/user-guide/io/table_provider.html index 410623c..215ed51 100644 --- a/user-guide/io/table_provider.html +++ b/user-guide/io/table_provider.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="../dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>
diff --git a/user-guide/sql.html b/user-guide/sql.html index e8d46a5..52eda79 100644 --- a/user-guide/sql.html +++ b/user-guide/sql.html
@@ -117,6 +117,11 @@ Data Sources </a> </li> + <li class="toctree-l1"> + <a class="reference internal" href="dataframe.html"> + DataFrames + </a> + </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="common-operations/index.html"> Common Operations @@ -276,6 +281,11 @@ </a> </li> <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/col/index.html"> + datafusion.col + </a> + </li> + <li class="toctree-l3"> <a class="reference internal" href="../autoapi/datafusion/context/index.html"> datafusion.context </a> @@ -295,6 +305,11 @@ datafusion.functions </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/html_formatter/index.html"> + datafusion.html_formatter + </a> + </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../autoapi/datafusion/input/index.html"> datafusion.input @@ -347,6 +362,16 @@ datafusion.udf </a> </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/unparser/index.html"> + datafusion.unparser + </a> + </li> + <li class="toctree-l3"> + <a class="reference internal" href="../autoapi/datafusion/user_defined/index.html"> + datafusion.user_defined + </a> + </li> </ul> </li> </ul>