org.neo4j.procedure.builtin.graphschema.GraphSchema Maven / Gradle / Ivy
Show all versions of neo4j-procedure Show documentation
/*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [https://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see nodeLabels;
/**
* Map from type (string value) to token.
*/
private final Map relationshipTypes;
/**
* Map from generated ID to instance.
*/
private final Map nodeObjectTypes;
/**
* Map from generated ID to instance.
*/
private final Map relationshipObjectTypes;
private GraphSchema(
Map nodeLabels,
Map relationshipTypes,
Map nodeObjectTypes,
Map relationshipObjectTypes) {
this.nodeLabels = nodeLabels;
this.relationshipTypes = relationshipTypes;
this.nodeObjectTypes = nodeObjectTypes;
this.relationshipObjectTypes = relationshipObjectTypes;
}
public Map nodeLabels() {
return nodeLabels;
}
public Map relationshipTypes() {
return relationshipTypes;
}
public Map nodeObjectTypes() {
return nodeObjectTypes;
}
public Map relationshipObjectTypes() {
return relationshipObjectTypes;
}
record Type(String value, String itemType) {}
record Property(String token, List types, boolean mandatory) {}
record NodeObjectType(String id, List labels, List properties) {
NodeObjectType(String id, List labels) {
this(id, labels, new ArrayList<>()); // Mutable on purpose
}
}
record Token(String id, String value) {}
record Ref(String value) {}
record RelationshipObjectType(String id, Ref type, Ref from, Ref to, List properties) {
RelationshipObjectType(String id, Ref type, Ref from, Ref to) {
this(id, type, from, to, new ArrayList<>()); // Mutable on purpose
}
}
static class Introspector {
/**
* Number of relationships to sample, defaults to the same value as used in APOC and GraphQL introspection as of writing.
*/
static final Long DEFAULT_SAMPLE_SIZE = 100L;
private static final Supplier ID_GENERATOR =
() -> UUID.randomUUID().toString();
private static final Pattern ENCLOSING_TICK_MARKS = Pattern.compile("^`(.+)`$");
private static final Map TYPE_MAPPING = Map.of(
"Long", "integer",
"Double", "float");
private final Transaction transaction;
private final Config config;
private Introspector(Transaction transaction, Config config) {
this.transaction = transaction;
this.config = config;
}
GraphSchema introspect() throws Exception {
var nodeLabels = getNodeLabels();
var relationshipTypes = getRelationshipTypes();
var nodeObjectTypeIdGenerator =
new CachingUnaryOperator<>(new NodeObjectIdGenerator(config.useConstantIds()));
var relationshipObjectIdGenerator = new RelationshipObjectIdGenerator(config.useConstantIds());
var nodeObjectTypes = getNodeObjectTypes(nodeObjectTypeIdGenerator, nodeLabels);
var relationshipObjectTypes = getRelationshipObjectTypes(
nodeObjectTypeIdGenerator, relationshipObjectIdGenerator, relationshipTypes);
return new GraphSchema(nodeLabels, relationshipTypes, nodeObjectTypes, relationshipObjectTypes);
}
private Map getNodeLabels() throws Exception {
return getToken(
transaction.getAllLabelsInUse(),
Label::name,
config.quoteTokens(),
config.useConstantIds() ? "nl:%s"::formatted : ignored -> ID_GENERATOR.get());
}
private Map getRelationshipTypes() throws Exception {
return getToken(
transaction.getAllRelationshipTypesInUse(),
RelationshipType::name,
config.quoteTokens(),
config.useConstantIds() ? "rt:%s"::formatted : ignored -> ID_GENERATOR.get());
}
private Map getToken(
Iterable tokensInUse,
Function nameExtractor,
boolean quoteTokens,
UnaryOperator idGenerator)
throws Exception {
Function valueMapper = Function.identity();
if (quoteTokens) {
valueMapper = token -> new Token(
token.id(), SchemaNames.sanitize(token.value()).orElse(token.value()));
}
try {
return StreamSupport.stream(tokensInUse.spliterator(), false)
.map(label -> {
var tokenValue = nameExtractor.apply(label);
return new Token(idGenerator.apply(tokenValue), tokenValue);
})
.collect(Collectors.toMap(Token::value, valueMapper));
} finally {
if (tokensInUse instanceof Resource resource) {
resource.close();
}
}
}
private static String getRelationshipPropertiesQuery(Config config) {
// language=cypher
var template =
"""
CALL db.schema.relTypeProperties() YIELD relType, propertyName, propertyTypes, mandatory
WITH substring(relType, 2, size(relType)-3) AS relType, propertyName, propertyTypes, mandatory
CALL {
WITH relType, propertyName
MATCH (n)-[r]->(m) WHERE type(r) = relType AND (r[propertyName] IS NOT NULL OR propertyName IS NULL)
WITH n, r, m
// LIMIT
WITH DISTINCT labels(n) AS from, labels(m) AS to
RETURN from, to
}
RETURN DISTINCT from, to, relType, propertyName, propertyTypes, mandatory
ORDER BY relType ASC
""";
if (config.sampleOnly()) {
return template.replace("// LIMIT\n", "LIMIT " + DEFAULT_SAMPLE_SIZE + "\n");
}
return template;
}
/**
* The main algorithm of retrieving node object types (or instances). It uses the existing procedure {@code db.schema.nodeTypeProperties}
* for building a map from nodeType to property sets.
*
* @param idGenerator The id generator
* @param labelIdToToken The map of existing token by id
* @return A map with the node object instances
* @throws Exception Any exception that might occur
*/
private Map getNodeObjectTypes(
UnaryOperator idGenerator, Map labelIdToToken) throws Exception {
if (labelIdToToken.isEmpty()) {
return Map.of();
}
// language=cypher
var query =
"""
CALL db.schema.nodeTypeProperties()
YIELD nodeType, nodeLabels, propertyName, propertyTypes, mandatory
RETURN *
ORDER BY nodeType ASC
""";
var nodeObjectTypes = new LinkedHashMap();
transaction.execute(query).accept((Result.ResultVisitor) resultRow -> {
@SuppressWarnings("unchecked")
var nodeLabels = ((List) resultRow.get("nodeLabels"))
.stream().sorted().toList();
var id = new Ref(idGenerator.apply(resultRow.getString("nodeType")));
var nodeObject = nodeObjectTypes.computeIfAbsent(
id,
key -> new NodeObjectType(
key.value,
nodeLabels.stream()
.map(l -> new Ref(labelIdToToken.get(l).id))
.toList()));
extractProperty(resultRow).ifPresent(nodeObject.properties()::add);
return true;
});
return nodeObjectTypes;
}
/**
* The main algorithm of retrieving node object types (or instances). It uses the existing procedure {@literal db.schema.relTypeProperties}
* for building a map from types to property sets.
*
* It does a full label scan.
*
* @param nodeObjectTypeIdGenerator The id generator f or node objects
* @param idGenerator The id generator for relationships
* @param relationshipIdToToken The map of existing token by id
* @return A map with the relationship object instances
* @throws Exception Any exception that might occur
*/
private Map getRelationshipObjectTypes(
UnaryOperator nodeObjectTypeIdGenerator,
BinaryOperator idGenerator,
Map relationshipIdToToken)
throws Exception {
if (relationshipIdToToken.isEmpty()) {
return Map.of();
}
var query = getRelationshipPropertiesQuery(config);
var relationshipObjectTypes = new LinkedHashMap();
transaction.execute(query).accept((Result.ResultVisitor) resultRow -> {
var relType = resultRow.getString("relType");
@SuppressWarnings("unchecked")
var from = nodeObjectTypeIdGenerator.apply(":"
+ ((List) resultRow.get("from"))
.stream().sorted().map(v -> "`" + v + "`").collect(Collectors.joining(":")));
@SuppressWarnings("unchecked")
var to = nodeObjectTypeIdGenerator.apply(":"
+ ((List) resultRow.get("to"))
.stream().sorted().map(v -> "`" + v + "`").collect(Collectors.joining(":")));
var id = new Ref(idGenerator.apply(relType, to));
var relationshipObject = relationshipObjectTypes.computeIfAbsent(
id,
key -> new RelationshipObjectType(
key.value,
new Ref(relationshipIdToToken.get(relType).id()),
new Ref(from),
new Ref(to)));
extractProperty(resultRow).ifPresent(relationshipObject.properties()::add);
return true;
});
return relationshipObjectTypes;
}
Optional extractProperty(Result.ResultRow resultRow) {
var propertyName = resultRow.getString("propertyName");
if (propertyName == null) {
return Optional.empty();
}
@SuppressWarnings("unchecked")
var types = ((List) resultRow.get("propertyTypes"))
.stream()
.map(t -> {
String type;
String itemType = null;
if (t.endsWith("Array")) {
type = "array";
itemType = t.replace("Array", "");
itemType = TYPE_MAPPING
.getOrDefault(itemType, itemType)
.toLowerCase(Locale.ROOT);
} else {
type = TYPE_MAPPING.getOrDefault(t, t).toLowerCase(Locale.ROOT);
}
return new Type(type, itemType);
})
.toList();
return Optional.of(new Property(propertyName, types, resultRow.getBoolean("mandatory")));
}
private static String splitStripAndJoin(String value, String prefix) {
return Arrays.stream(value.split(":"))
.map(String::trim)
.filter(Predicate.not(String::isBlank))
.map(t -> ENCLOSING_TICK_MARKS.matcher(t).replaceAll(m -> m.group(1)))
.collect(Collectors.joining(":", prefix + ":", ""));
}
private static class NodeObjectIdGenerator implements UnaryOperator {
private final boolean useConstantIds;
NodeObjectIdGenerator(boolean useConstantIds) {
this.useConstantIds = useConstantIds;
}
@Override
public String apply(String nodeType) {
if (useConstantIds) {
return splitStripAndJoin(nodeType, "n");
}
return ID_GENERATOR.get();
}
}
/**
* Not thread safe.
*/
private static class RelationshipObjectIdGenerator implements BinaryOperator {
private final boolean useConstantIds;
private final Map> counter = new HashMap<>();
RelationshipObjectIdGenerator(boolean useConstantIds) {
this.useConstantIds = useConstantIds;
}
@Override
public String apply(String relType, String target) {
if (useConstantIds) {
var id = splitStripAndJoin(relType, "r");
var count = counter.computeIfAbsent(id, ignored -> new HashMap<>());
if (count.isEmpty()) {
count.put(target, 0);
return id;
} else if (count.containsKey(target)) {
var value = count.get(target);
return value == 0 ? id : id + "_" + value;
} else {
var newValue = count.size();
count.put(target, newValue);
return id + "_" + newValue;
}
}
return ID_GENERATOR.get();
}
}
/**
* Not thread safe.
*/
private static class CachingUnaryOperator implements UnaryOperator {
private final Map cache = new HashMap<>();
private final UnaryOperator delegate;
CachingUnaryOperator(UnaryOperator delegate) {
this.delegate = delegate;
}
@Override
public T apply(T s) {
return cache.computeIfAbsent(s, delegate);
}
}
}
}