Skip to content

Commit 9aa50ec

Browse files
committed
docs: enhance file_sort_order documentation in SessionContext
1 parent 8a8c17f commit 9aa50ec

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

python/datafusion/context.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -567,7 +567,9 @@ def register_listing_table(
567567
table_partition_cols: Partition columns.
568568
file_extension: File extension of the provided table.
569569
schema: The data source schema.
570-
file_sort_order: Sort order for the file.
570+
file_sort_order: Sort order for the file. Each sort key can be
571+
specified as a column name (``str``), an expression
572+
(``Expr``), or a ``SortExpr``.
571573
"""
572574
if table_partition_cols is None:
573575
table_partition_cols = []
@@ -822,7 +824,9 @@ def register_parquet(
822824
that may be in the file schema. This can help avoid schema
823825
conflicts due to metadata.
824826
schema: The data source schema.
825-
file_sort_order: Sort order for the file.
827+
file_sort_order: Sort order for the file. Each sort key can be
828+
specified as a column name (``str``), an expression
829+
(``Expr``), or a ``SortExpr``.
826830
"""
827831
if table_partition_cols is None:
828832
table_partition_cols = []
@@ -1109,7 +1113,9 @@ def read_parquet(
11091113
schema: An optional schema representing the parquet files. If None,
11101114
the parquet reader will try to infer it based on data in the
11111115
file.
1112-
file_sort_order: Sort order for the file.
1116+
file_sort_order: Sort order for the file. Each sort key can be
1117+
specified as a column name (``str``), an expression
1118+
(``Expr``), or a ``SortExpr``.
11131119
11141120
Returns:
11151121
DataFrame representation of the read Parquet files

0 commit comments

Comments
 (0)