cymple.builder.YieldAvailable

class cymple.builder.YieldAvailable(query)

Bases: QueryStartAvailable, Node, Where, Return

A class decorator declares a Yield 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.
`node`([labels, ref_name, properties])	Concatenate a graph Node, which may be filtered using any label/s and/or property/properties.
`return_literal`(literal)	Concatenate a literal RETURN statement.
`return_mapping`(mappings)	Concatenate a RETURN statement for multiple objects.
`where`(name, comparison_operator, value, **kwargs)	Concatenate a WHERE clause to the query, created as {name} {comparison_operator} {value}.
`where_literal`(statement, **kwargs)	Concatenate a literal WHERE clause to the query.
`where_multiple`(filters[, ...])	Concatenate a WHERE clause to the query, created from a list of given property filters.
`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

node(labels: List[str] | str | None = None, ref_name: str | None = None, properties: dict | None = None, **kwargs)

Concatenate a graph Node, which may be filtered using any label/s and/or property/properties.

Parameters:

labels (Union[List[str], str]) – The neo4j label (or list of labels) for that node, defaults to None
ref_name (str) – A reference name to be used later in the rest of the query, defaults to None
properties (dict) – A dict representing the set of properties by which the nodes are filtered, defaults to None
**kwargs –
kwargs

:type **kwargs

Returns:: A Query object with a query that contains the new clause.
Return type:: NodeAvailable

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

where(name: str, comparison_operator: str, value: str, **kwargs)

Concatenate a WHERE clause to the query, created as {name} {comparison_operator} {value}. E.g. x = ‘abc’.

Parameters:

name (str) – The name of the object which is to be used in the comparison
comparison_operator (str) – A string operator, according to which the comparison between compared object and the {value} is done, e.g. for “=”, we get: {name} = {value}
value (str) – The value which is compared against
**kwargs –
kwargs

:type **kwargs

Returns:: A Query object with a query that contains the new clause.
Return type:: WhereAvailable

where_literal(statement: str, **kwargs)

Concatenate a literal WHERE clause to the query.

Parameters:

statement (str) – A literal string of the required filter
**kwargs –
kwargs

:type **kwargs

Returns:: A Query object with a query that contains the new clause.
Return type:: WhereAvailable

where_multiple(filters: dict, comparison_operator: str = '=', boolean_operator: str = ' AND ', **kwargs)

Concatenate a WHERE clause to the query, created from a list of given property filters.

Parameters:

filters (dict) – A dict representing the set of properties to be filtered
comparison_operator (str) – A string operator, according to which the comparison between property values is done, e.g. for “=”, we get: property.name = property.value, defaults to “=”
boolean_operator (str) – The boolean operator to apply between predicates, defaults to ‘ AND ‘
**kwargs –
kwargs

:type **kwargs

Returns:: A Query object with a query that contains the new clause.
Return type:: WhereAvailable

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