Skip to content

Commit 0c0d92f

Browse files
fix: Rendering of DFS append_table_data doc string (#161)
1 parent 7825032 commit 0c0d92f

File tree

2 files changed

+18
-14
lines changed

2 files changed

+18
-14
lines changed

docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@ sphinx-autodoc-typehints
33
sphinx-rtd-theme
44
docutils==0.16
55
autodoc_pydantic
6+
pyarrow >= 21.0.0
67
.

nisystemlink/clients/dataframe/_data_frame_client.py

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -291,21 +291,24 @@ def append_table_data(
291291
292292
Args:
293293
id: Unique ID of a data table.
294-
data: The data to append. Supported forms:
295-
* AppendTableDataRequest: Sent as-is via JSON; ``end_of_data`` must be ``None``.
296-
* DataFrame (service model): Wrapped into an AppendTableDataRequest (``end_of_data``
297-
optional) and sent as JSON.
298-
* Single pyarrow.RecordBatch: Treated the same as an iterable containing one batch
299-
and streamed as Arrow IPC. ``end_of_data`` (if provided) is sent as a query
300-
parameter.
301-
* Iterable[pyarrow.RecordBatch]: Streamed as Arrow IPC. ``end_of_data`` (if provided)
302-
is sent as a query parameter. If the iterator yields no batches, it is treated
303-
as ``None`` and requires ``end_of_data``.
304-
* None: ``end_of_data`` must be provided; sends JSON containing only the
305-
``endOfData`` flag.
294+
data: The data to append.
295+
296+
Supported forms:
297+
298+
* ``AppendTableDataRequest``: Sent as-is via JSON; ``end_of_data`` must be ``None``.
299+
* ``DataFrame`` (service model): Wrapped into an
300+
``AppendTableDataRequest`` (``end_of_data`` optional) and sent as JSON.
301+
* Single ``pyarrow.RecordBatch``: Treated the same as an iterable containing one
302+
batch and streamed as Arrow IPC. ``end_of_data`` (if provided) is sent as a
303+
query parameter.
304+
* ``Iterable[pyarrow.RecordBatch]``: Streamed as Arrow IPC. ``end_of_data`` (if
305+
provided) is sent as a query parameter. If the iterator yields no batches, it is
306+
treated as ``None`` and requires ``end_of_data``.
307+
* ``None``: ``end_of_data`` must be provided; sends JSON containing only the
308+
``endOfData`` flag (useful for closing a table without appending rows).
306309
end_of_data: Whether additional rows may be appended in future requests. Required when
307-
``data`` is ``None`` or the RecordBatch iterator is empty; must be omitted when
308-
passing an ``AppendTableDataRequest`` (include it inside that model instead).
310+
``data`` is ``None`` or the RecordBatch iterator is empty; must be omitted when
311+
passing an ``AppendTableDataRequest`` (include it inside that model instead).
309312
310313
Raises:
311314
ValueError: If parameter constraints are violated.

0 commit comments

Comments
 (0)