API reference
python:irx:irx.record_batch.RecordBatch
class RecordBatch
RecordBatch(handle: ctypes.c_void_p, lib: ctypes.CDLL)
Source: packages/irx/src/irx/record_batch.py:1473
RecordBatch.
Null-slot behaviour is uniform across every getter: a null value reads
back as the zero value of its type (0 for numerics, empty string for
utf8/large_utf8, epoch-relative 0 for date/timestamp/time). Callers
that need to distinguish a real zero/empty value from a null must
check is_null(col, row) first.
Attributes
-
_handle — Type: ctypes.c_void_p
-
_lib — Type: ctypes.CDLL
-
_released — Type: bool
Methods
-
__del__ — Release the batch when the object is garbage collected.
-
__init__ — Create a wrapper around an existing native batch handle.
-
_scalar_get — Read a scalar value from the batch through a native getter.
-
from_arrow — Import a PyArrow batch, retaining independent native buffers.
-
get_bool — Return a boolean value from the batch.
-
get_date — Return the raw storage int for a date32 or date64 column.
-
get_float32 — Return a 32-bit floating-point value from the batch.
-
get_float64 — Return a 64-bit floating-point value from the batch.
-
get_int16 — Return a 16-bit signed integer value from the batch.
-
get_int32 — Return a 32-bit signed integer value from the batch.
-
get_int64 — Return a 64-bit signed integer value from the batch.
-
get_int8 — Return an 8-bit signed integer value from the batch.
-
get_list — Return the list at a list-column row, or None if it is null.
-
get_string — Return a UTF-8 string from a utf8 or large_utf8 column.
-
get_struct — Return the struct at a struct-column row, or None if it is null.
-
get_time — Return the raw storage int for a time32 or time64 column.
-
get_timestamp — Return the raw storage int for a timestamp column.
-
get_uint16 — Return a 16-bit unsigned integer value from the batch.
-
get_uint32 — Return a 32-bit unsigned integer value from the batch.
-
get_uint64 — Return a 64-bit unsigned integer value from the batch.
-
get_uint8 — Return an 8-bit unsigned integer value from the batch.
-
is_null — Return whether the value at the supplied location is null.
-
release — Release the underlying batch handle.
-
to_arrow — Export independent PyArrow buffers, including nested values.
Properties
-
num_columns — Return the number of columns in the batch.
-
num_rows — Return the number of rows in the batch.