org.neo4j.procedure.builtin.SchemaCalculator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-procedure Show documentation
Show all versions of neo4j-procedure Show documentation
Neo4j Community Procedures.
The newest version!
/*
* 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 propertyIdToPropertyNameMapping;
private final MutableIntSet emptyPropertyIdSet = IntSets.mutable.empty();
private final Read dataRead;
private final TokenRead tokenRead;
private final CursorFactory cursors;
private final CursorContext cursorContext;
private final MemoryTracker memoryTracker;
SchemaCalculator(KernelTransaction ktx) {
this.dataRead = ktx.dataRead();
this.tokenRead = ktx.tokenRead();
this.cursors = ktx.cursors();
this.cursorContext = ktx.cursorContext();
this.memoryTracker = ktx.memoryTracker();
// the only one that is common for both nodes and rels so thats why we can do it here
propertyIdToPropertyNameMapping = new HashMap<>(tokenRead.propertyKeyCount());
addNamesToCollection(tokenRead.propertyKeyGetAllTokens(), propertyIdToPropertyNameMapping);
}
private NodeMappings initializeMappingsForNodes() {
int labelCount = tokenRead.labelCount();
return new NodeMappings(labelCount);
}
private RelationshipMappings initializeMappingsForRels() {
int relationshipTypeCount = tokenRead.relationshipTypeCount();
return new RelationshipMappings(relationshipTypeCount);
}
// If we would have this schema information in the count store (or somewhere), this could be super fast
public Stream calculateTabularResultStreamForNodes() {
NodeMappings nodeMappings = initializeMappingsForNodes();
scanEverythingBelongingToNodes(nodeMappings, cursorContext, memoryTracker);
// go through all labels to get actual names
addNamesToCollection(tokenRead.labelsGetAllTokens(), nodeMappings.labelIdToLabelName);
return produceResultsForNodes(nodeMappings).stream();
}
public Stream calculateTabularResultStreamForRels() {
RelationshipMappings relMappings = initializeMappingsForRels();
scanEverythingBelongingToRelationships(relMappings, cursorContext, memoryTracker);
// go through all relationshipTypes to get actual names
addNamesToCollection(
tokenRead.relationshipTypesGetAllTokens(), relMappings.relationshipTypIdToRelationshipName);
return produceResultsForRelationships(relMappings).stream();
}
private List produceResultsForRelationships(
RelationshipMappings relMappings) {
List results = new ArrayList<>();
for (Integer typeId : relMappings.relationshipTypeIdToPropertyKeys.keySet()) {
// lookup typ name
String name = relMappings.relationshipTypIdToRelationshipName.get(typeId);
name = ":`" + name + "`"; // escaping
// lookup property value types
MutableIntSet propertyIds = relMappings.relationshipTypeIdToPropertyKeys.get(typeId);
if (propertyIds.size() == 0) {
results.add(new RelationshipPropertySchemaInfoResult(name, null, null, false));
} else {
String finalName = name;
propertyIds.forEach(propId -> {
// lookup propId name and valueGroup
String propName = propertyIdToPropertyNameMapping.get(propId);
ValueTypeListHelper valueTypeListHelper =
relMappings.relationshipTypeIdANDPropertyTypeIdToValueType.get(
new RelationshipTypePropertyKey(typeId, propId));
if (relMappings.nullableRelationshipTypes.contains(typeId)) {
results.add(new RelationshipPropertySchemaInfoResult(
finalName, propName, valueTypeListHelper.getCypherTypesList(), false));
} else {
results.add(new RelationshipPropertySchemaInfoResult(
finalName,
propName,
valueTypeListHelper.getCypherTypesList(),
valueTypeListHelper.isMandatory()));
}
});
}
}
return results;
}
private List produceResultsForNodes(NodeMappings nodeMappings) {
List results = new ArrayList<>();
for (SortedLabels labelSet : nodeMappings.labelSetToPropertyKeys.keySet()) {
// lookup label names and produce list of names and produce String out of them
List labelNames = new ArrayList<>();
for (int i = 0; i < labelSet.numberOfLabels(); i++) {
String name = nodeMappings.labelIdToLabelName.get(labelSet.label(i));
labelNames.add(name);
}
Collections.sort(labelNames); // this is optional but waaaaay nicer
StringBuilder labelsConcatenator = new StringBuilder();
for (String item : labelNames) {
labelsConcatenator.append(":`").append(item).append('`');
}
String labels = labelsConcatenator.toString();
// lookup property value types
MutableIntSet propertyIds = nodeMappings.labelSetToPropertyKeys.get(labelSet);
if (propertyIds.size() == 0) {
results.add(new NodePropertySchemaInfoResult(labels, labelNames, null, null, false));
} else {
propertyIds.forEach(propId -> {
// lookup propId name and valueGroup
String propName = propertyIdToPropertyNameMapping.get(propId);
ValueTypeListHelper valueTypeListHelper = nodeMappings.labelSetANDNodePropertyKeyIdToValueType.get(
new LabelSetPropertyKey(labelSet, propId));
if (nodeMappings.nullableLabelSets.contains(labelSet)) {
results.add(new NodePropertySchemaInfoResult(
labels, labelNames, propName, valueTypeListHelper.getCypherTypesList(), false));
} else {
results.add(new NodePropertySchemaInfoResult(
labels,
labelNames,
propName,
valueTypeListHelper.getCypherTypesList(),
valueTypeListHelper.isMandatory()));
}
});
}
}
return results;
}
private void scanEverythingBelongingToRelationships(
RelationshipMappings relMappings, CursorContext cursorContext, MemoryTracker memoryTracker) {
try (RelationshipScanCursor relationshipScanCursor =
cursors.allocateRelationshipScanCursor(cursorContext, memoryTracker);
PropertyCursor propertyCursor = cursors.allocatePropertyCursor(cursorContext, memoryTracker)) {
dataRead.allRelationshipsScan(relationshipScanCursor);
while (relationshipScanCursor.next()) {
int typeId = relationshipScanCursor.type();
relationshipScanCursor.properties(propertyCursor);
MutableIntSet propertyIds = IntSets.mutable.empty();
while (propertyCursor.next()) {
int propertyKey = propertyCursor.propertyKey();
Value currentValue = propertyCursor.propertyValue();
var key = new RelationshipTypePropertyKey(typeId, propertyKey);
updateValueTypeInMapping(
currentValue, key, relMappings.relationshipTypeIdANDPropertyTypeIdToValueType);
propertyIds.add(propertyKey);
}
propertyCursor.close();
MutableIntSet oldPropertyKeySet =
relMappings.relationshipTypeIdToPropertyKeys.getOrDefault(typeId, emptyPropertyIdSet);
// find out which old properties we did not visited and mark them as nullable
if (oldPropertyKeySet == emptyPropertyIdSet) {
if (propertyIds.size() == 0) {
// Even if we find property key on other rels with this type, set all of them nullable
relMappings.nullableRelationshipTypes.add(typeId);
}
propertyIds.addAll(oldPropertyKeySet);
} else {
MutableIntSet currentPropertyIdsHelperSet = new IntHashSet(propertyIds.size());
currentPropertyIdsHelperSet.addAll(propertyIds);
propertyIds.removeAll(oldPropertyKeySet); // only the brand new ones in propIds now
oldPropertyKeySet.removeAll(
currentPropertyIdsHelperSet); // only the old ones that are not on the new rel
propertyIds.addAll(oldPropertyKeySet);
propertyIds.forEach(id -> {
var key = new RelationshipTypePropertyKey(typeId, id);
relMappings
.relationshipTypeIdANDPropertyTypeIdToValueType
.get(key)
.setNullable();
});
propertyIds.addAll(currentPropertyIdsHelperSet);
}
relMappings.relationshipTypeIdToPropertyKeys.put(typeId, propertyIds);
}
}
}
private void scanEverythingBelongingToNodes(
NodeMappings nodeMappings, CursorContext cursorContext, MemoryTracker memoryTracker) {
try (NodeCursor nodeCursor = cursors.allocateNodeCursor(cursorContext, memoryTracker);
PropertyCursor propertyCursor = cursors.allocatePropertyCursor(cursorContext, memoryTracker)) {
dataRead.allNodesScan(nodeCursor);
while (nodeCursor.next()) {
// each node
SortedLabels labels = SortedLabels.from(nodeCursor.labels());
nodeCursor.properties(propertyCursor);
MutableIntSet propertyIds = IntSets.mutable.empty();
while (propertyCursor.next()) {
Value currentValue = propertyCursor.propertyValue();
int propertyKeyId = propertyCursor.propertyKey();
var key = new LabelSetPropertyKey(labels, propertyKeyId);
updateValueTypeInMapping(currentValue, key, nodeMappings.labelSetANDNodePropertyKeyIdToValueType);
propertyIds.add(propertyKeyId);
}
propertyCursor.close();
MutableIntSet oldPropertyKeySet =
nodeMappings.labelSetToPropertyKeys.getOrDefault(labels, emptyPropertyIdSet);
// find out which old properties we did not visited and mark them as nullable
if (oldPropertyKeySet == emptyPropertyIdSet) {
if (propertyIds.size() == 0) {
// Even if we find property key on other nodes with those labels, set all of them nullable
nodeMappings.nullableLabelSets.add(labels);
}
propertyIds.addAll(oldPropertyKeySet);
} else {
MutableIntSet currentPropertyIdsHelperSet = new IntHashSet(propertyIds.size());
currentPropertyIdsHelperSet.addAll(propertyIds);
propertyIds.removeAll(oldPropertyKeySet); // only the brand new ones in propIds now
oldPropertyKeySet.removeAll(
currentPropertyIdsHelperSet); // only the old ones that are not on the new node
propertyIds.addAll(oldPropertyKeySet);
propertyIds.forEach(id -> {
var key = new LabelSetPropertyKey(labels, id);
nodeMappings
.labelSetANDNodePropertyKeyIdToValueType
.get(key)
.setNullable();
});
propertyIds.addAll(currentPropertyIdsHelperSet);
}
nodeMappings.labelSetToPropertyKeys.put(labels, propertyIds);
}
}
}
private static void updateValueTypeInMapping(
Value currentValue, T key, Map mappingToUpdate) {
ValueTypeListHelper helper = mappingToUpdate.get(key);
if (helper == null) {
helper = new ValueTypeListHelper(currentValue);
mappingToUpdate.put(key, helper);
} else {
helper.updateValueTypesWith(currentValue);
}
}
private static void addNamesToCollection(Iterator labelIterator, Map collection) {
while (labelIterator.hasNext()) {
NamedToken label = labelIterator.next();
collection.put(label.id(), label.name());
}
}
private static class ValueTypeListHelper {
private final Set seenValueTypes;
private boolean isMandatory = true;
ValueTypeListHelper(Value v) {
seenValueTypes = new HashSet<>();
updateValueTypesWith(v);
}
private void setNullable() {
isMandatory = false;
}
public boolean isMandatory() {
return isMandatory;
}
List getCypherTypesList() {
return new ArrayList<>(seenValueTypes);
}
void updateValueTypesWith(Value newValue) {
if (newValue == null) {
throw new IllegalArgumentException();
}
seenValueTypes.add(newValue.getTypeName());
}
}
/*
All mappings needed to describe Nodes except for property infos
*/
private static class NodeMappings {
final Map labelSetToPropertyKeys;
final Map labelSetANDNodePropertyKeyIdToValueType;
final Set
nullableLabelSets; // used for label combinations without properties -> all properties are viewed as
// nullable
final Map labelIdToLabelName;
NodeMappings(int labelCount) {
labelSetToPropertyKeys = new HashMap<>(labelCount);
labelIdToLabelName = new HashMap<>(labelCount);
labelSetANDNodePropertyKeyIdToValueType = new HashMap<>();
nullableLabelSets = new HashSet<>();
}
}
private record LabelSetPropertyKey(SortedLabels sortedLabels, int proprtyId) {}
/*
All mappings needed to describe Rels except for property infos
*/
private static class RelationshipMappings {
final Map relationshipTypIdToRelationshipName;
final Map relationshipTypeIdToPropertyKeys;
final Map relationshipTypeIdANDPropertyTypeIdToValueType;
final Set
nullableRelationshipTypes; // used for types without properties -> all properties are viewed as nullable
RelationshipMappings(int relationshipTypeCount) {
relationshipTypIdToRelationshipName = new HashMap<>(relationshipTypeCount);
relationshipTypeIdToPropertyKeys = new HashMap<>(relationshipTypeCount);
relationshipTypeIdANDPropertyTypeIdToValueType = new HashMap<>();
nullableRelationshipTypes = new HashSet<>();
}
}
private record RelationshipTypePropertyKey(int relationshipType, int propertyId) {}
}