Package org.neo4j.gds.legacycypherprojection

Interface GraphProjectFromCypherConfig

All Superinterfaces:

org.neo4j.gds.config.BaseConfig, org.neo4j.gds.config.GraphProjectConfig, org.neo4j.gds.config.JobIdConfig, org.neo4j.gds.config.ToMapConvertible

@Configuration
public interface GraphProjectFromCypherConfig
extends org.neo4j.gds.config.GraphProjectConfig

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALL_NODES_QUERY
static final String	ALL_RELATIONSHIPS_QUERY
static final List<String>	FORBIDDEN_KEYS
static final String	NODE_QUERY_KEY
static final String	RELATIONSHIP_QUERY_KEY

Fields inherited from interface org.neo4j.gds.config.BaseConfig

LOG_PROGRESS_KEY, SUDO_KEY

Fields inherited from interface org.neo4j.gds.config.GraphProjectConfig

IMPLICIT_GRAPH_NAME, NODE_COUNT_KEY, READ_CONCURRENCY_KEY, RELATIONSHIP_COUNT_KEY, VALIDATE_RELATIONSHIPS_KEY

Method Summary

Modifier and Type	Method	Description
default Map<String,Object>	asProcedureResultConfigurationField()
static void	assertNoProjectionsOrExplicitProperties(org.neo4j.gds.core.CypherMapWrapper config)
static GraphProjectFromCypherConfig	fromProcedureConfig(String username, org.neo4j.gds.core.CypherMapWrapper config)
default org.neo4j.gds.api.GraphStoreFactory.Supplier	graphStoreFactory()
static Collection<String>	listParameterKeys(Map<String,Object> parameters)
String	nodeQuery()
static GraphProjectFromCypherConfig	of(String userName, String graphName, String nodeQuery, String relationshipQuery, org.neo4j.gds.core.CypherMapWrapper config)
default Set<String>	outputFieldDenylist()
default Map<String,Object>	parameters()
String	relationshipQuery()
default boolean	sudo()
default boolean	validateRelationships()

Methods inherited from interface org.neo4j.gds.config.BaseConfig

configKeys, logProgress, toMap, usernameOverride

Methods inherited from interface org.neo4j.gds.config.GraphProjectConfig

cleansed, creationTime, graphName, isFictitiousLoading, nodeCount, readConcurrency, relationshipCount, username, validateReadConcurrency

Methods inherited from interface org.neo4j.gds.config.JobIdConfig

jobId

Field Details

FORBIDDEN_KEYS

static final List<String> FORBIDDEN_KEYS

NODE_QUERY_KEY

static final String NODE_QUERY_KEY

See Also:

• Constant Field Values

RELATIONSHIP_QUERY_KEY

static final String RELATIONSHIP_QUERY_KEY

See Also:

• Constant Field Values

ALL_NODES_QUERY

static final String ALL_NODES_QUERY

See Also:

• Constant Field Values

ALL_RELATIONSHIPS_QUERY

static final String ALL_RELATIONSHIPS_QUERY

See Also:

• Constant Field Values

Method Details

asProcedureResultConfigurationField

@Ignore
default Map<String,Object> asProcedureResultConfigurationField()

Specified by:

asProcedureResultConfigurationField in interface org.neo4j.gds.config.GraphProjectConfig

nodeQuery

@ConvertWith(method="org.apache.commons.lang3.StringUtils#trimToNull")
String nodeQuery()

relationshipQuery

@ConvertWith(method="org.apache.commons.lang3.StringUtils#trimToNull")
String relationshipQuery()

parameters

@ToMapValue("org.neo4j.gds.legacycypherprojection.GraphProjectFromCypherConfig#listParameterKeys")
default Map<String,Object> parameters()

validateRelationships

default boolean validateRelationships()

Specified by:

validateRelationships in interface org.neo4j.gds.config.GraphProjectConfig

graphStoreFactory

@Ignore
default org.neo4j.gds.api.GraphStoreFactory.Supplier graphStoreFactory()

Specified by:

graphStoreFactory in interface org.neo4j.gds.config.GraphProjectConfig

sudo

default boolean sudo()

Specified by:

sudo in interface org.neo4j.gds.config.BaseConfig

outputFieldDenylist

@Ignore
default Set<String> outputFieldDenylist()

of

static GraphProjectFromCypherConfig of(String userName,
 String graphName,
 String nodeQuery,
 String relationshipQuery,
 org.neo4j.gds.core.CypherMapWrapper config)

fromProcedureConfig

static GraphProjectFromCypherConfig fromProcedureConfig(String username,
 org.neo4j.gds.core.CypherMapWrapper config)

assertNoProjectionsOrExplicitProperties

static void assertNoProjectionsOrExplicitProperties(org.neo4j.gds.core.CypherMapWrapper config)

listParameterKeys

static Collection<String> listParameterKeys(Map<String,Object> parameters)