Package org.neo4j.gds.config

Interface GraphProjectFromCypherConfig

All Superinterfaces:

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

@Configuration
public interface GraphProjectFromCypherConfig
extends GraphProjectConfig

Nested Class Summary

Nested classes/interfaces inherited from interface org.neo4j.gds.config.GraphProjectConfig

GraphProjectConfig.Cases<R>, GraphProjectConfig.Visitor

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ALL_NODES_QUERY
static java.lang.String	ALL_RELATIONSHIPS_QUERY
static java.util.List<java.lang.String>	FORBIDDEN_KEYS
static java.lang.String	NODE_QUERY_KEY
static java.lang.String	RELATIONSHIP_QUERY_KEY

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

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 <R> R	accept(GraphProjectConfig.Cases<R> visitor)
static void	assertNoProjectionsOrExplicitProperties(org.neo4j.gds.core.CypherMapWrapper config)
static GraphProjectFromCypherConfig	fromProcedureConfig(java.lang.String username, org.neo4j.gds.core.CypherMapWrapper config)
default GraphStoreFactory.Supplier	graphStoreFactory()
java.lang.String	nodeQuery()
static GraphProjectFromCypherConfig	of(java.lang.String userName, java.lang.String graphName, java.lang.String nodeQuery, java.lang.String relationshipQuery, org.neo4j.gds.core.CypherMapWrapper config)
default java.util.Set<java.lang.String>	outputFieldDenylist()
default java.util.Map<java.lang.String,java.lang.Object>	parameters()
java.lang.String	relationshipQuery()
default boolean	sudo()
default boolean	validateRelationships()

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

configKeys, toMap, usernameOverride

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

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

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

jobId

Field Detail

FORBIDDEN_KEYS

static final java.util.List<java.lang.String> FORBIDDEN_KEYS

NODE_QUERY_KEY

static final java.lang.String NODE_QUERY_KEY

See Also:

Constant Field Values

RELATIONSHIP_QUERY_KEY

static final java.lang.String RELATIONSHIP_QUERY_KEY

See Also:

Constant Field Values

ALL_NODES_QUERY

static final java.lang.String ALL_NODES_QUERY

See Also:

Constant Field Values

ALL_RELATIONSHIPS_QUERY

static final java.lang.String ALL_RELATIONSHIPS_QUERY

See Also:

Constant Field Values

Method Detail

nodeQuery

@ConvertWith("org.apache.commons.lang3.StringUtils#trimToNull")
java.lang.String nodeQuery()

relationshipQuery

@ConvertWith("org.apache.commons.lang3.StringUtils#trimToNull")
java.lang.String relationshipQuery()

parameters

@Default
default java.util.Map<java.lang.String,java.lang.Object> parameters()

validateRelationships

@Default
@Parameter(false)
default boolean validateRelationships()

Specified by:

validateRelationships in interface GraphProjectConfig

graphStoreFactory

@Ignore
default GraphStoreFactory.Supplier graphStoreFactory()

Specified by:

graphStoreFactory in interface GraphProjectConfig

sudo

@Default
@Parameter(false)
default boolean sudo()

Specified by:

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

accept

@Ignore
default <R> R accept(GraphProjectConfig.Cases<R> visitor)

Specified by:

accept in interface GraphProjectConfig

outputFieldDenylist

@Derived
@Ignore
default java.util.Set<java.lang.String> outputFieldDenylist()

of

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

fromProcedureConfig

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

assertNoProjectionsOrExplicitProperties

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