feat: Add optional take to DataFrame Service export table data request model (#177)

Support for restricting the number of rows returned by the export table data route. The default is to return all rows.

Author: spanglerco

examples/dataframe/export_data.py

@@ -26,7 +26,7 @@
     "0001-01-01T00:00:00Z" if index_column.data_type == DataType.Timestamp else "0"
 )
 
-# Export table data with query options
+# Export the first 100,000 rows of table data with query options
 request = ExportTableDataRequest(
     columns=[index_column.name],
     order_by=[ColumnOrderBy(column=order_column.name, descending=True)],
@@ -37,6 +37,7 @@
             value=filter_value,
         )
     ],
+    take=100000,
     response_format=ExportFormat.CSV,
 )
 

nisystemlink/clients/dataframe/models/_export_table_data_request.py

@@ -35,6 +35,13 @@ class ExportTableDataRequest(JsonModel):
     filtering do not need to be included in the columns list, in which case
     they are not included in the export."""
 
+    take: int | None = None
+    """The maximum number of rows to include in the export. If ``None``
+    (the default), all rows are included. Added in version 3 of the
+    :py:attr:`nisystemlink.clients.dataframe.models.OperationsV1.read_data`
+    operation. Older versions of the service will ignore this value and
+    always include all rows."""
+
     response_format: ExportFormat
     """The format of the exported data. The only response format
     currently supported is ``CSV``."""