pyarrow.compute.SortOptions

class pyarrow.compute.SortOptions(sort_keys=(), *, null_placement=None)

Bases: _SortOptions

Options for the sort_indices function.

Parameters:

sort_keyssequence of (name, order, null_placement) tuples

Names of field/column keys to sort the input on, along with the order each field/column is sorted in. Accepted values for order are “ascending”, “descending”. Accepted values for null_placement are “at_start”, “at_end”. The field name can be a string column name or expression.

null_placementstr | None, default None

Where nulls in input should be sorted, overwrites null_placement in sort_keys. Accepted values are “at_start”, “at_end”.

__init__(self, sort_keys=(), *, null_placement=None)

Methods

__init__(self[, sort_keys, null_placement])
deserialize(buf)	Deserialize options for a function.
serialize(self)

static deserialize(buf)

Deserialize options for a function.

Parameters:

bufBuffer

The buffer containing the data to deserialize.

serialize(self)