Skip to content

Commit

Permalink
Added more details to python comments
Browse files Browse the repository at this point in the history
  • Loading branch information
malhotrashivam committed Mar 27, 2024
1 parent f700883 commit 6246289
Showing 1 changed file with 18 additions and 15 deletions.
33 changes: 18 additions & 15 deletions py/server/deephaven/parquet.py
Original file line number Diff line number Diff line change
Expand Up @@ -273,11 +273,12 @@ def write(
defaults to False. Generating these files can help speed up reading of partitioned parquet data because these
files contain metadata (including schema) about the entire dataset, which can be used to skip reading some
files.
index_columns (Optional[List[List[str]]]): Lists containing the column names for indexes to persist. The write
operation will store the index info as sidecar tables. By default, data indexes to write are determined by
those present on the source table. This argument is used to narrow the set of indexes to write, or to be
explicit about the expected set of indexes present on all sources. Indexes that are specified but missing
will be computed on demand.
index_columns (Optional[List[List[str]]]): list of list containing the column names for indexes to persist. The
write operation will store the index info for the provided columns as sidecar tables. For example, if the
input is [["Col1"], ["Col1", "Col2"]], the write operation will store the index info for ["Col1"] and for
["Col1", "Col2"]. By default, data indexes to write are determined by those present on the source table.
This argument can be used to narrow the set of indexes to write, or to be explicit about the expected set of
indexes present on all sources. Indexes that are specified but missing will be computed on demand.
Raises:
DHError
Expand Down Expand Up @@ -358,11 +359,12 @@ def write_partitioned(
defaults to False. Generating these files can help speed up reading of partitioned parquet data because these
files contain metadata (including schema) about the entire dataset, which can be used to skip reading some
files.
index_columns (Optional[List[List[str]]]): Lists containing the column names for indexes to persist. The write
operation will store the index info as sidecar tables. By default, data indexes to write are determined by
those present on the source table. This argument is used to narrow the set of indexes to write, or to be
explicit about the expected set of indexes present on all sources. Indexes that are specified but missing
will be computed on demand.
index_columns (Optional[List[List[str]]]): list of list containing the column names for indexes to persist. The
write operation will store the index info for the provided columns as sidecar tables. For example, if the
input is [["Col1"], ["Col1", "Col2"]], the write operation will store the index info for ["Col1"] and for
["Col1", "Col2"]. By default, data indexes to write are determined by those present on the source table.
This argument can be used to narrow the set of indexes to write, or to be explicit about the expected set of
indexes present on all sources. Indexes that are specified but missing will be computed on demand.
Raises:
DHError
Expand Down Expand Up @@ -435,11 +437,12 @@ def batch_write(
defaults to False. Generating these files can help speed up reading of partitioned parquet data because these
files contain metadata (including schema) about the entire dataset, which can be used to skip reading some
files.
index_columns (Optional[List[List[str]]]): Lists containing the column names for indexes to persist. The write
operation will store the index info as sidecar tables. By default, data indexes to write are determined by
those present on the source table. This argument is used to narrow the set of indexes to write, or to be
explicit about the expected set of indexes present on all sources. Indexes that are specified but missing
will be computed on demand.
index_columns (Optional[List[List[str]]]): list of list containing the column names for indexes to persist. The
write operation will store the index info for the provided columns as sidecar tables. For example, if the
input is [["Col1"], ["Col1", "Col2"]], the write operation will store the index info for ["Col1"] and for
["Col1", "Col2"]. By default, data indexes to write are determined by those present on the source table.
This argument can be used to narrow the set of indexes to write, or to be explicit about the expected set of
indexes present on all sources. Indexes that are specified but missing will be computed on demand.
Raises:
DHError
Expand Down

0 comments on commit 6246289

Please sign in to comment.