cymple.builder.OperatorStartAvailable

class cymple.builder.OperatorStartAvailable(query)

Bases: QueryStartAvailable, Node, OperatorEnd

A class decorator declares a OperatorStart 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.
operator_end()	Concatenate the "OPERATOR END" clause.
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

operator_end()

Concatenate the “OPERATOR END” clause.

Returns:

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

Return type:

OperatorEndAvailable

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