cymple.builder.WhereAvailable
- class cymple.builder.WhereAvailable(query)
Bases:
Return
,Delete
,Where
,Set
,Remove
,OperatorStart
,QueryStartAvailable
A class decorator declares a Where 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
delete
(ref_name)Concatenate a DELETE clause for a referenced instance from the DB.
detach_delete
(ref_name)Concatenate a DETACH DELETE clause for a referenced instance from the DB.
get
()Get the final query string .
match
()Concatenate the "MATCH" clause.
Concatenate the "MATCH" clause.
merge
()Concatenate the "MERGE" clause.
operator_start
(operator[, ref_name, args])Concatenate an operator (e.g. ShortestPath), where its result may be given a name for future reference.
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.
set
(properties[, escape_values])Concatenate a SET clause, using the given properties map.
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:
- create()
Concatenate the “CREATE” clause.
- Returns:
A Query object with a query that contains the new clause.
- Return type:
- cypher(cypher_query_str)
Concatenate a cypher query string
- delete(ref_name: str)
Concatenate a DELETE clause for a referenced instance from the DB.
- Parameters:
ref_name (str) – The reference name to be used for the delete operation
- Returns:
A Query object with a query that contains the new clause.
- Return type:
- detach_delete(ref_name: str)
Concatenate a DETACH DELETE clause for a referenced instance from the DB.
- Parameters:
ref_name (str) – The reference name to be used for the delete operation
- Returns:
A Query object with a query that contains the new clause.
- Return type:
- 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:
- match_optional()
Concatenate the “MATCH” clause.
- Returns:
A Query object with a query that contains the new clause.
- Return type:
- merge()
Concatenate the “MERGE” clause.
- Returns:
A Query object with a query that contains the new clause.
- Return type:
- operator_start(operator: str, ref_name: str | None = None, args: dict | None = None)
Concatenate an operator (e.g. ShortestPath), where its result may be given a name for future reference.
- Parameters:
operator (str) – The neo4j operator to be used (e.g. ShortestPath)
ref_name (str) – A reference name of the result, to be used later in the rest of the query, defaults to None
args (dict) – A dict of arguments, to be passed to the operator function, defaults to None
- Returns:
A Query object with a query that contains the new clause.
- Return type:
- 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:
- 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:
- 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:
- 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:
- 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:
- 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:
- 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:
- 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: