cymple.builder.OrderBy

class cymple.builder.OrderBy(query)

Bases: Query

A class for representing a “ORDER BY” clause.

__init__(query)

Initialize the query object.

Methods

__init__(query)

Initialize the query object.

cypher(cypher_query_str)

Concatenate a cypher query string

get()

Get the final query string .

order_by(sorting_properties[, ascending])

Concatenate an order by statement.
cypher(cypher_query_str)

Concatenate a cypher query string

get()

Get the final query string .

order_by(sorting_properties: str | List[str], ascending: bool = True)

Concatenate an order by statement.

Parameters:

  • sorting_properties (Union[str, List[str]]) – A string or a list of strings representing the properties based on which to sort.

  • ascending (bool) – Use ascending sorting (if false, uses descending)., defaults to True

Returns:

A Query object with a query that contains the new clause.

Return type:

OrderByAvailable