cymple.builder.UnwindAvailable

class cymple.builder.UnwindAvailable(query)

Bases: QueryStartAvailable, Unwind, Return, Create, Remove

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

__init__(query)

Initialize the query object.

Methods

__init__(query)	Initialize the query object.
call()	Concatenate the "CALL" clause.
create()	Concatenate the "CREATE" clause.
cypher(cypher_query_str)	Concatenate a cypher query string
get()	Get the final query string .
match()	Concatenate the "MATCH" clause.
match_optional()	Concatenate the "MATCH" clause.
merge()	Concatenate the "MERGE" clause.
remove(properties)	Concatenate a remove by statement.
return_literal(literal)	Concatenate a literal RETURN statement.
return_mapping(mappings)	Concatenate a RETURN statement for multiple objects.
unwind(variables)	Concatenate an UNWIND clause, keeping one or more variables given in 'variables' arg.
with_(variables)	Concatenate a WITH clause, keeping one or more variables given in 'variables' arg.

call()

Concatenate the “CALL” clause.

Returns:

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

Return type:

CallAvailable

create()

Concatenate the “CREATE” clause.

Returns:

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

Return type:

CreateAvailable

cypher(cypher_query_str)

Concatenate a cypher query string

get()

Get the final query string .

match()

Concatenate the “MATCH” clause.

Returns:

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

Return type:

MatchAvailable

match_optional()

Concatenate the “MATCH” clause.

Returns:

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

Return type:

MatchAvailable

merge()

Concatenate the “MERGE” clause.

Returns:

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

Return type:

MergeAvailable

remove(properties: str | List[str])

Concatenate a remove by statement.

Parameters:

properties (Union[str, List[str]]) – A string or a list of strings representing the properties to remove.

Returns:

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

Return type:

RemoveAvailable

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

unwind(variables: str)

Concatenate an UNWIND clause, keeping one or more variables given in ‘variables’ arg.

Parameters:

variables (str) – A string refering to previously obtained variables, comma seperated

Returns:

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

Return type:

UnwindAvailable

with_(variables: str)

Concatenate a WITH clause, keeping one or more variables given in ‘variables’ arg.

Parameters:

variables (str) – A string refering to previously obtained variables, comma seperated

Returns:

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

Return type:

WithAvailable