pyarrow.compute.SortOptions

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

Bases: _SortOptions

Options for the sort_indices function.

Parameters:
sort_keyssequence of (name, order) 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”. The field name can be a string column name or expression.

null_placementstr, default “at_end”

Where nulls in input should be sorted, only applying to columns/fields mentioned in sort_keys. Accepted values are “at_start”, “at_end”.

__init__(self, sort_keys=(), *, null_placement='at_end')

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)