cymple.builder.Yield

class cymple.builder.Yield(query)

Bases: Query

A class for representing a “YIELD” clause.

__init__(query)

Initialize the query object.

Methods

__init__(query)	Initialize the query object.
cypher(cypher_query_str)	Concatenate a cypher query string
get()	Get the final query string .
yield_(mappings)	Concatenate a YIELD cluase, to yield a list of Mappings.

cypher(cypher_query_str)

Concatenate a cypher query string

get()

Get the final query string .

yield_(mappings: List[Mapping])

Concatenate a YIELD cluase, to yield a list of Mappings.

Parameters:

mappings (List[Mapping]) – The list of mappings of db properties names to code names, to be yielded

Returns:

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

Return type:

YieldAvailable