Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: correct pydocs for table_definition in parquet #5981

Merged
merged 1 commit into from
Aug 23, 2024
Merged

fix: correct pydocs for table_definition in parquet #5981

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions py/server/deephaven/parquet.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ def read(
is_refreshing (bool): if the parquet data represents a refreshing source
file_layout (Optional[ParquetFileLayout]): the parquet file layout, by default None. When None, the layout is
inferred.
table_definition (Union[Dict[str, DType], List[Column], None]): the table definition, by default None. When None,
table_definition (Optional[TableDefinitionLike]): the table definition, by default None. When None,
the definition is inferred from the parquet file(s). Setting a definition guarantees the returned table will
have that definition. This is useful for bootstrapping purposes when the initially partitioned directory is
empty and is_refreshing=True. It is also useful for specifying a subset of the parquet definition.
Expand Down Expand Up @@ -250,7 +250,7 @@ def write(
path (str): the destination file path or URI; the file name should end in a ".parquet" extension. If the path
includes any non-existing directories, they are created. If there is an error, any intermediate directories
previously created are removed; note this makes this method unsafe for concurrent use
table_definition (Optional[Union[Dict[str, DType], List[Column]]): the table definition to use for writing,
table_definition (Optional[TableDefinitionLike]): the table definition to use for writing,
instead of the definitions implied by the table. Default is None, which means use the column definitions
implied by the table. This definition can be used to skip some columns or add additional columns with
null values.
Expand Down Expand Up @@ -322,7 +322,7 @@ def write_partitioned(
destination_dir (str): The path or URI to the destination root directory in which the partitioned parquet data
will be stored in a nested directory structure format. Non-existing directories in the provided path will be
created.
table_definition (Optional[Union[Dict[str, DType], List[Column]]): the table definition to use for writing,
table_definition (Optional[TableDefinitionLike]): the table definition to use for writing,
instead of the definitions implied by the table. Default is None, which means use the column definitions
implied by the table. This definition can be used to skip some columns or add additional columns with
null values.
Expand Down Expand Up @@ -405,7 +405,7 @@ def batch_write(
paths (List[str]): the destination paths or URIs. Any non-existing directories in the paths provided are
created. If there is an error, any intermediate directories previously created are removed; note this makes
this method unsafe for concurrent use
table_definition (Optional[Union[Dict[str, DType], List[Column]]]): the table definition to use for writing.
table_definition (Optional[TableDefinitionLike]): the table definition to use for writing.
This definition can be used to skip some columns or add additional columns with null values. Default is
None, which means if all tables have the same definition, use the common table definition implied by the
tables. Otherwise, this parameter must be specified.
Expand Down