Package org.neo4j.gds.config

Interface WriteConfig

All Superinterfaces:

ConcurrencyConfig

All Known Subinterfaces:

WriteLabelConfig, WritePropertyConfig, WriteRelationshipConfig, WriteRelationshipPropertiesConfig

public interface WriteConfig
extends ConcurrencyConfig

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	WriteConfig.ArrowConnectionInfo

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	WRITE_CONCURRENCY_KEY

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

CONCURRENCY_KEY, CONCURRENCY_LIMITATION, DEFAULT_CONCURRENCY

Method Summary

Modifier and Type	Method	Description
java.util.Optional<WriteConfig.ArrowConnectionInfo>	arrowConnectionInfo()	This config option will only exist temporarily for testing the "serverless" architecture.
default void	validateGraphIsSuitableForWrite(GraphStore graphStore, java.util.Collection<org.neo4j.gds.NodeLabel> selectedLabels, java.util.Collection<org.neo4j.gds.RelationshipType> selectedRelationshipTypes)
default void	validateWriteConcurrency()
default int	writeConcurrency()

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

concurrency, minBatchSize, validateConcurrency

Field Detail

WRITE_CONCURRENCY_KEY

static final java.lang.String WRITE_CONCURRENCY_KEY

See Also:

Constant Field Values

Method Detail

writeConcurrency

@Default
@Key("writeConcurrency")
default int writeConcurrency()

validateWriteConcurrency

@Check
default void validateWriteConcurrency()

arrowConnectionInfo

@ConvertWith(method="org.neo4j.gds.config.WriteConfig.ArrowConnectionInfo#parse")
java.util.Optional<WriteConfig.ArrowConnectionInfo> arrowConnectionInfo()

This config option will only exist temporarily for testing the "serverless" architecture. It should only be used for arrow write-back. In the final version we will no longer pass this information in procedure calls, but replace those calls with an arrow protocol. Note that not every write-back path supports forwarding this information to the export builders.

validateGraphIsSuitableForWrite

@GraphStoreValidationCheck
@Default
default void validateGraphIsSuitableForWrite(GraphStore graphStore,
                                             java.util.Collection<org.neo4j.gds.NodeLabel> selectedLabels,
                                             java.util.Collection<org.neo4j.gds.RelationshipType> selectedRelationshipTypes)