Skip to content

Commit

Permalink
Final changes to procedure signature and structure
Browse files Browse the repository at this point in the history
  • Loading branch information
@SaschaPeukert
SaschaPeukert committed Oct 15, 2018
1 parent 79fc72b commit d01636f
Show file tree
Hide file tree
Showing 7 changed files with 120 additions and 93 deletions.
150 changes: 88 additions & 62 deletions ...y-it/kernel-it/src/test/java/org/neo4j/kernel/builtinprocs/BuiltInSchemaProceduresIT.java
View file

Large diffs are not rendered by default.

9 changes: 5 additions & 4 deletions ...ernel-it/src/test/java/org/neo4j/kernel/impl/api/integrationtest/BuiltInProceduresIT.java
View file
Expand Up @@ -149,11 +149,12 @@ public void listProcedures() throws Throwable
"Show the schema of the data.", "READ" ), "Show the schema of the data.", "READ" ),
proc( "db.schema.visualization","() :: (nodes :: LIST? OF NODE?, relationships :: LIST? OF RELATIONSHIP?)", proc( "db.schema.visualization","() :: (nodes :: LIST? OF NODE?, relationships :: LIST? OF RELATIONSHIP?)",
"Visualize the schema of the data. Replaces db.schema.", "READ" ), "Visualize the schema of the data. Replaces db.schema.", "READ" ),
proc( "db.schema.nodeProperties", "() :: (nodeType :: STRING?, propertyName :: STRING?, " + proc( "db.schema.nodeTypeProperties",
"propertyTypes :: LIST? OF STRING?, mandatory :: BOOLEAN?)", "Show the derived property schema of the nodes in tabular form.", "() :: (nodeType :: STRING?, nodeLabels :: LIST? OF STRING?, propertyName :: STRING?, " +
"READ" ),
proc( "db.schema.edgeProperties", "() :: (relationshipType :: STRING?, propertyName :: STRING?, " +
"propertyTypes :: LIST? OF STRING?, mandatory :: BOOLEAN?)", "propertyTypes :: LIST? OF STRING?, mandatory :: BOOLEAN?)",
"Show the derived property schema of the nodes in tabular form.", "READ" ),
proc( "db.schema.relTypeProperties", "() :: (relType :: STRING?, " +
"propertyName :: STRING?, propertyTypes :: LIST? OF STRING?, mandatory :: BOOLEAN?)",
"Show the derived property schema of the relationships in tabular form.", "READ" ), "Show the derived property schema of the relationships in tabular form.", "READ" ),
proc( "db.relationshipTypes", "() :: (relationshipType :: " + "STRING?)", proc( "db.relationshipTypes", "() :: (relationshipType :: " + "STRING?)",
"List all relationship types in the database.", "READ" ), "List all relationship types in the database.", "READ" ),
Expand Down
4 changes: 2 additions & 2 deletions community/kernel/src/main/java/org/neo4j/kernel/builtinprocs/BuiltInProcedures.java
View file
Expand Up @@ -215,14 +215,14 @@ public void resampleOutdatedIndexes()
} }
} }


@Procedure( name = "db.schema.nodeProperties", mode = Mode.READ ) @Procedure( name = "db.schema.nodeTypeProperties", mode = Mode.READ )
@Description( "Show the derived property schema of the nodes in tabular form." ) @Description( "Show the derived property schema of the nodes in tabular form." )
public Stream<NodePropertySchemaInfoResult> nodePropertySchema() public Stream<NodePropertySchemaInfoResult> nodePropertySchema()
{ {
return new SchemaCalculator( tx ).calculateTabularResultStreamForNodes(); return new SchemaCalculator( tx ).calculateTabularResultStreamForNodes();
} }


@Procedure( name = "db.schema.edgeProperties", mode = Mode.READ ) @Procedure( name = "db.schema.relTypeProperties", mode = Mode.READ )
@Description( "Show the derived property schema of the relationships in tabular form." ) @Description( "Show the derived property schema of the relationships in tabular form." )
public Stream<RelationshipPropertySchemaInfoResult> relationshipPropertySchema() public Stream<RelationshipPropertySchemaInfoResult> relationshipPropertySchema()
{ {
Expand Down
11 changes: 8 additions & 3 deletions ...nity/kernel/src/main/java/org/neo4j/kernel/builtinprocs/NodePropertySchemaInfoResult.java
View file
Expand Up @@ -24,10 +24,14 @@
public class NodePropertySchemaInfoResult public class NodePropertySchemaInfoResult
{ {
/** /**
* A combination of labels interleaved by ":" * A combination of escaped label names interleaved by ":"
*/ */
public final String nodeType; public final String nodeType;


/**
* A list of label names
*/
public final List<String> nodeLabels;
/** /**
* A property name that occurs on the given label combination or null * A property name that occurs on the given label combination or null
*/ */
Expand All @@ -43,9 +47,10 @@ public class NodePropertySchemaInfoResult
*/ */
public final boolean mandatory; public final boolean mandatory;


public NodePropertySchemaInfoResult( String nodeLabels, String propertyName, List<String> cypherTypes, boolean mandatory ) public NodePropertySchemaInfoResult( String nodeType, List<String> nodeLabelsList, String propertyName, List<String> cypherTypes, boolean mandatory )
{ {
this.nodeType = nodeLabels; this.nodeType = nodeType;
this.nodeLabels = nodeLabelsList;
this.propertyName = propertyName; this.propertyName = propertyName;
this.propertyTypes = cypherTypes; this.propertyTypes = cypherTypes;
this.mandatory = mandatory; this.mandatory = mandatory;
Expand Down
4 changes: 2 additions & 2 deletions ...nel/src/main/java/org/neo4j/kernel/builtinprocs/RelationshipPropertySchemaInfoResult.java
View file
Expand Up @@ -26,7 +26,7 @@ public class RelationshipPropertySchemaInfoResult
/** /**
* A relationship type * A relationship type
*/ */
public final String relationshipType; public final String relType;


/** /**
* A property name that occurs on the given relationship type or null * A property name that occurs on the given relationship type or null
Expand All @@ -45,7 +45,7 @@ public class RelationshipPropertySchemaInfoResult


public RelationshipPropertySchemaInfoResult( String relType, String propertyName, List<String> cypherTypes, boolean mandatory ) public RelationshipPropertySchemaInfoResult( String relType, String propertyName, List<String> cypherTypes, boolean mandatory )
{ {
this.relationshipType = relType; this.relType = relType;
this.propertyName = propertyName; this.propertyName = propertyName;
this.propertyTypes = cypherTypes; this.propertyTypes = cypherTypes;
this.mandatory = mandatory; this.mandatory = mandatory;
Expand Down
23 changes: 9 additions & 14 deletions community/kernel/src/main/java/org/neo4j/kernel/builtinprocs/SchemaCalculator.java
View file
Expand Up @@ -86,7 +86,7 @@ public Stream<NodePropertySchemaInfoResult> calculateTabularResultStreamForNodes
// go through all labels to get actual names // go through all labels to get actual names
addNamesToCollection( tokenRead.labelsGetAllTokens(), nodeMappings.labelIdToLabelName ); addNamesToCollection( tokenRead.labelsGetAllTokens(), nodeMappings.labelIdToLabelName );


return produceResultsForNodes(nodeMappings).stream(); return produceResultsForNodes( nodeMappings ).stream();
} }


public Stream<RelationshipPropertySchemaInfoResult> calculateTabularResultStreamForRels() public Stream<RelationshipPropertySchemaInfoResult> calculateTabularResultStreamForRels()
Expand All @@ -107,6 +107,7 @@ private List<RelationshipPropertySchemaInfoResult> produceResultsForRelationship
{ {
// lookup typ name // lookup typ name
String name = relMappings.relationshipTypIdToRelationshipName.get( typeId ); String name = relMappings.relationshipTypIdToRelationshipName.get( typeId );
name = ":`" + name + "`"; // escaping


// lookup property value types // lookup property value types
MutableIntSet propertyIds = relMappings.relationshipTypeIdToPropertyKeys.get( typeId ); MutableIntSet propertyIds = relMappings.relationshipTypeIdToPropertyKeys.get( typeId );
Expand All @@ -116,18 +117,19 @@ private List<RelationshipPropertySchemaInfoResult> produceResultsForRelationship
} }
else else
{ {
String finalName = name;
propertyIds.forEach( propId -> { propertyIds.forEach( propId -> {
// lookup propId name and valueGroup // lookup propId name and valueGroup
String propName = propertyIdToPropertyNameMapping.get( propId ); String propName = propertyIdToPropertyNameMapping.get( propId );
ValueTypeListHelper valueTypeListHelper = relMappings.relationshipTypeIdANDPropertyTypeIdToValueType.get( Pair.of( typeId, propId ) ); ValueTypeListHelper valueTypeListHelper = relMappings.relationshipTypeIdANDPropertyTypeIdToValueType.get( Pair.of( typeId, propId ) );
if ( relMappings.nullableRelationshipTypes.contains( typeId ) ) if ( relMappings.nullableRelationshipTypes.contains( typeId ) )
{ {
results.add( new RelationshipPropertySchemaInfoResult( name, propName, valueTypeListHelper.getCypherTypesList(), results.add( new RelationshipPropertySchemaInfoResult( finalName, propName, valueTypeListHelper.getCypherTypesList(),
false ) ); false ) );
} }
else else
{ {
results.add( new RelationshipPropertySchemaInfoResult( name, propName, valueTypeListHelper.getCypherTypesList(), results.add( new RelationshipPropertySchemaInfoResult( finalName, propName, valueTypeListHelper.getCypherTypesList(),
valueTypeListHelper.isMandatory() ) ); valueTypeListHelper.isMandatory() ) );
} }
} ); } );
Expand All @@ -152,22 +154,15 @@ private List<NodePropertySchemaInfoResult> produceResultsForNodes( NodeMappings
StringBuilder labelsConcatenator = new StringBuilder(); StringBuilder labelsConcatenator = new StringBuilder();
for ( String item : labelNames ) for ( String item : labelNames )
{ {
if ( labelsConcatenator.toString().equals( "" ) ) labelsConcatenator.append( ":`" ).append( item ).append( "`" );
{
labelsConcatenator.append( item );
}
else
{
labelsConcatenator.append( ":" ).append( item );
}
} }
String labels = labelsConcatenator.toString(); String labels = labelsConcatenator.toString();


// lookup property value types // lookup property value types
MutableIntSet propertyIds = nodeMappings.labelSetToPropertyKeys.get( labelSet ); MutableIntSet propertyIds = nodeMappings.labelSetToPropertyKeys.get( labelSet );
if ( propertyIds.size() == 0 ) if ( propertyIds.size() == 0 )
{ {
results.add( new NodePropertySchemaInfoResult( labels, null, null, false ) ); results.add( new NodePropertySchemaInfoResult( labels, labelNames, null, null, false ) );
} }
else else
{ {
Expand All @@ -177,11 +172,11 @@ private List<NodePropertySchemaInfoResult> produceResultsForNodes( NodeMappings
ValueTypeListHelper valueTypeListHelper = nodeMappings.labelSetANDNodePropertyKeyIdToValueType.get( Pair.of( labelSet, propId ) ); ValueTypeListHelper valueTypeListHelper = nodeMappings.labelSetANDNodePropertyKeyIdToValueType.get( Pair.of( labelSet, propId ) );
if ( nodeMappings.nullableLabelSets.contains( labelSet ) ) if ( nodeMappings.nullableLabelSets.contains( labelSet ) )
{ {
results.add( new NodePropertySchemaInfoResult( labels, propName, valueTypeListHelper.getCypherTypesList(), false ) ); results.add( new NodePropertySchemaInfoResult( labels, labelNames, propName, valueTypeListHelper.getCypherTypesList(), false ) );
} }
else else
{ {
results.add( new NodePropertySchemaInfoResult( labels, propName, valueTypeListHelper.getCypherTypesList(), results.add( new NodePropertySchemaInfoResult( labels, labelNames, propName, valueTypeListHelper.getCypherTypesList(),
valueTypeListHelper.isMandatory() ) ); valueTypeListHelper.isMandatory() ) );
} }
} ); } );
Expand Down
12 changes: 6 additions & 6 deletions community/kernel/src/test/java/org/neo4j/kernel/builtinprocs/BuiltInProceduresTest.java
View file
Expand Up @@ -289,13 +289,13 @@ public void shouldListCorrectBuiltinProcedures() throws Throwable
record( "db.schema.visualization", record( "db.schema.visualization",
"db.schema.visualization() :: (nodes :: LIST? OF NODE?, relationships :: LIST? OF RELATIONSHIP?)", "db.schema.visualization() :: (nodes :: LIST? OF NODE?, relationships :: LIST? OF RELATIONSHIP?)",
"Visualize the schema of the data. Replaces db.schema.", "READ" ), "Visualize the schema of the data. Replaces db.schema.", "READ" ),
record( "db.schema.nodeProperties", record( "db.schema.nodeTypeProperties",
"db.schema.nodeProperties() :: (nodeType :: STRING?, propertyName :: STRING?," + "db.schema.nodeTypeProperties() :: (nodeType :: STRING?, nodeLabels :: LIST? OF STRING?, propertyName :: STRING?, " +
" propertyTypes :: LIST? OF STRING?, mandatory :: BOOLEAN?)",
"Show the derived property schema of the nodes in tabular form.", "READ" ),
record( "db.schema.edgeProperties",
"db.schema.edgeProperties() :: (relationshipType :: STRING?, propertyName :: STRING?, " +
"propertyTypes :: LIST? OF STRING?, mandatory :: BOOLEAN?)", "propertyTypes :: LIST? OF STRING?, mandatory :: BOOLEAN?)",
"Show the derived property schema of the nodes in tabular form.", "READ" ),
record( "db.schema.relTypeProperties",
"db.schema.relTypeProperties() :: (relType :: STRING?, propertyName :: STRING?, propertyTypes :: LIST? OF STRING?," +
" mandatory :: BOOLEAN?)",
"Show the derived property schema of the relationships in tabular form.", "READ" ), "Show the derived property schema of the relationships in tabular form.", "READ" ),
record( "db.index.explicit.searchNodes", record( "db.index.explicit.searchNodes",
"db.index.explicit.searchNodes(indexName :: STRING?, query :: ANY?) :: (node :: NODE?, weight :: FLOAT?)", "db.index.explicit.searchNodes(indexName :: STRING?, query :: ANY?) :: (node :: NODE?, weight :: FLOAT?)",
Expand Down

0 comments on commit d01636f

Please sign in to comment.