cymple.builder.Return

class cymple.builder.Return(query)

Bases: Query

A class for representing a “RETURN” 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 .
return_literal(literal)	Concatenate a literal RETURN statement.
return_mapping(mappings)	Concatenate a RETURN statement for multiple objects.

cypher(cypher_query_str)

Concatenate a cypher query string

get()

Get the final query string .

return_literal(literal: str)

Concatenate a literal RETURN statement.

Parameters:

literal (str) – A Cypher string describing the objects to be returned, referencing name/names which were defined earlier in the query

Returns:

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

Return type:

ReturnAvailable

return_mapping(mappings: List[Mapping])

Concatenate a RETURN statement for multiple objects.

Parameters:

mappings (List[Mapping]) – The mapping (or a list of mappings) of db property names to code names, to be returned

Returns:

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

Return type:

ReturnAvailable