cymple.builder.RemoveAvailable

class cymple.builder.RemoveAvailable(query)

A class decorator declares a Remove is available in the current query.

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.
`set`(properties[, escape_values])	Concatenate a SET clause, using the given properties map.
`union`()	Combines the results of two or more queries.
`union_all`()	Combines the results of two or more queries including duplicates.

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

set(properties: dict, escape_values: bool = True)

Concatenate a SET clause, using the given properties map.

Parameters:

properties (dict) – A dict to be used to set the variables with their corresponding values
escape_values (bool) – Determines whether the properties values should be escaped or not, defaults to True

Returns:

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

Return type:

SetAvailable

union()

Combines the results of two or more queries. Duplicates are removed.

union_all()

Combines the results of two or more queries including duplicates.