org.neo4j.procedure.builtin.BuiltInProcedures 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.
/*
* 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 databaseInfo() {
var storeIdProvider = graphDatabaseAPI.getDependencyResolver().resolveDependency(StoreIdProvider.class);
var creationTime = formatTime(storeIdProvider.getStoreId().getCreationTime(), getConfiguredTimeZone());
return Stream.of(new DatabaseInfo(decodeId(storeIdProvider), graphDatabaseAPI.databaseName(), creationTime));
}
@SystemProcedure
@NotThreadSafe
@Description("List all labels attached to nodes within a database according to the user's access rights. "
+ "The procedure returns empty results if the user is not authorized to view those labels.")
@Procedure(name = "db.labels", mode = READ)
public Stream listLabels() {
if (callContext.isSystemDatabase()) {
return Stream.empty();
}
AccessMode mode = kernelTransaction.securityContext().mode();
TokenRead tokenRead = kernelTransaction.tokenRead();
List labelsInUse;
try (KernelTransaction.Revertable ignore = kernelTransaction.overrideWith(SecurityContext.AUTH_DISABLED)) {
// Get all labels that are in use as seen by a super user
labelsInUse = stream(LABELS.inUse(
kernelTransaction.dataRead(),
kernelTransaction.schemaRead(),
kernelTransaction.tokenRead()))
// filter out labels that are denied or aren't explicitly allowed
.filter(label -> mode.allowsTraverseNode(tokenRead.nodeLabel(label.name())))
.map(LabelResult::new)
.collect(Collectors.toList());
}
return labelsInUse.stream();
}
@SystemProcedure
@NotThreadSafe
@Description("List all property keys in the database.")
@Procedure(name = "db.propertyKeys", mode = READ)
public Stream listPropertyKeys() {
if (callContext.isSystemDatabase()) {
return Stream.empty();
}
List propertyKeys = stream(PROPERTY_KEYS.all(kernelTransaction.tokenRead()))
.map(PropertyKeyResult::new)
.toList();
return propertyKeys.stream();
}
@SystemProcedure
@NotThreadSafe
@Description("List all types attached to relationships within a database according to the user's access rights. "
+ "The procedure returns empty results if the user is not authorized to view those relationship types.")
@Procedure(name = "db.relationshipTypes", mode = READ)
public Stream listRelationshipTypes() {
if (callContext.isSystemDatabase()) {
return Stream.empty();
}
AccessMode mode = kernelTransaction.securityContext().mode();
TokenRead tokenRead = kernelTransaction.tokenRead();
List relTypesInUse;
try (KernelTransaction.Revertable ignore = kernelTransaction.overrideWith(SecurityContext.AUTH_DISABLED)) {
// Get all relTypes that are in use as seen by a super user
relTypesInUse = stream(RELATIONSHIP_TYPES.inUse(
kernelTransaction.dataRead(),
kernelTransaction.schemaRead(),
kernelTransaction.tokenRead()))
// filter out relTypes that are denied or aren't explicitly allowed
.filter(type -> mode.allowsTraverseRelType(tokenRead.relationshipType(type.name())))
.map(RelationshipTypeResult::new)
.collect(Collectors.toList());
}
return relTypesInUse.stream();
}
@SystemProcedure
@NotThreadSafe
@Description("Wait for an index to come online (for example: CALL db.awaitIndex(\"MyIndex\", 300)).")
@Procedure(name = "db.awaitIndex", mode = READ)
public void awaitIndex(
@Name(value = "indexName", description = "The name of the awaited index.") String indexName,
@Name(value = "timeOutSeconds", defaultValue = "300", description = "The maximum time to wait in seconds.")
long timeout)
throws ProcedureException {
if (callContext.isSystemDatabase()) {
return;
}
IndexProcedures indexProcedures = indexProcedures();
indexProcedures.awaitIndexByName(indexName, timeout, TimeUnit.SECONDS);
}
@SystemProcedure
@NotThreadSafe
@Description("Wait for all indexes to come online (for example: CALL db.awaitIndexes(300)).")
@Procedure(name = "db.awaitIndexes", mode = READ)
public void awaitIndexes(
@Name(value = "timeOutSeconds", defaultValue = "300", description = "The maximum time to wait in seconds.")
long timeout) {
if (callContext.isSystemDatabase()) {
return;
}
transaction.schema().awaitIndexesOnline(timeout, TimeUnit.SECONDS);
}
@SystemProcedure
@NotThreadSafe
@Description("Schedule resampling of an index (for example: CALL db.resampleIndex(\"MyIndex\")).")
@Procedure(name = "db.resampleIndex", mode = READ)
@UnsupportedDatabaseTypes(UnsupportedDatabaseTypes.DatabaseType.SPD)
public void resampleIndex(@Name(value = "indexName", description = "The name of the index.") String indexName)
throws ProcedureException {
if (callContext.isSystemDatabase()) {
return;
}
IndexProcedures indexProcedures = indexProcedures();
indexProcedures.resampleIndex(indexName);
}
@SystemProcedure
@NotThreadSafe
@Description("Schedule resampling of all outdated indexes.")
@Procedure(name = "db.resampleOutdatedIndexes", mode = READ)
@UnsupportedDatabaseTypes(UnsupportedDatabaseTypes.DatabaseType.SPD)
public void resampleOutdatedIndexes() {
if (callContext.isSystemDatabase()) {
return;
}
IndexProcedures indexProcedures = indexProcedures();
indexProcedures.resampleOutdatedIndexes();
}
@Admin
@SystemProcedure
@NotThreadSafe
@Description(
"Triggers an index resample and waits for it to complete, and after that clears query caches. After this "
+ "procedure has finished queries will be planned using the latest database statistics.")
@Procedure(name = "db.prepareForReplanning", mode = READ)
@UnsupportedDatabaseTypes(UnsupportedDatabaseTypes.DatabaseType.SPD)
public void prepareForReplanning(
@Name(value = "timeOutSeconds", defaultValue = "300", description = "The maximum time to wait in seconds.")
long timeOutSeconds)
throws ProcedureException {
if (callContext.isSystemDatabase()) {
return;
}
// Resample indexes
IndexProcedures indexProcedures = indexProcedures();
indexProcedures.resampleOutdatedIndexes(timeOutSeconds);
// now that index-stats are up-to-date, clear caches so that we are ready to re-plan
graphDatabaseAPI
.getDependencyResolver()
.resolveDependency(QueryExecutionEngine.class)
.clearQueryCaches();
}
@SystemProcedure
@NotThreadSafe
@Procedure(name = "db.schema.nodeTypeProperties", mode = Mode.READ)
@Description("Show the derived property schema of the nodes in tabular form.")
public Stream nodePropertySchema() {
if (callContext.isSystemDatabase()) {
return Stream.empty();
}
return new SchemaCalculator(kernelTransaction).calculateTabularResultStreamForNodes();
}
@SystemProcedure
@NotThreadSafe
@Procedure(name = "db.schema.relTypeProperties", mode = Mode.READ)
@Description("Show the derived property schema of the relationships in tabular form.")
public Stream relationshipPropertySchema() {
if (callContext.isSystemDatabase()) {
return Stream.empty();
}
return new SchemaCalculator(kernelTransaction).calculateTabularResultStreamForRels();
}
@SystemProcedure
@NotThreadSafe
@Description("Visualizes the schema of the data based on available statistics. "
+ "A new node is returned for each label. The properties represented on the node include: "
+ "`name` (label name), `indexes` (list of indexes), and `constraints` (list of constraints). "
+ "A relationship of a given type is returned for all possible combinations of start and end nodes. "
+ "The properties represented on the relationship include: `name` (type name). "
+ "Note that this may include additional relationships that do not exist in the data due to the "
+ "information available in the count store. ")
@Procedure(name = "db.schema.visualization", mode = READ)
public Stream schemaVisualization() {
if (callContext.isSystemDatabase()) {
return Stream.empty();
}
return Stream.of(new SchemaProcedure((InternalTransaction) transaction).buildSchemaGraph());
}
@SystemProcedure(allowExpiredCredentials = true)
@NotThreadSafe
@Procedure(name = "db.ping", mode = READ)
@Description(
"This procedure can be used by client side tooling to test whether they are correctly connected to a database. "
+ "The procedure is available in all databases and always returns true. A faulty connection can be detected by not being able to call this "
+ "procedure.")
public Stream ping() {
return Stream.of(new BooleanResult(Boolean.TRUE));
}
private ZoneId getConfiguredTimeZone() {
Config config = resolver.resolveDependency(Config.class);
return config.get(GraphDatabaseSettings.db_timezone).getZoneId();
}
private IndexProcedures indexProcedures() {
return new IndexProcedures(kernelTransaction, resolver.resolveDependency(IndexingService.class));
}
private IndexProviderDescriptor getIndexProviderDescriptor(String providerName) {
return resolver.resolveDependency(IndexingService.class).indexProviderByName(providerName);
}
public static class LabelResult {
@Description("A label within the database.")
public final String label;
private LabelResult(Label label) {
this.label = label.name();
}
}
public record PropertyKeyResult(@Description("A property key in the database.") String propertyKey) {}
public record DatabaseInfo(
@Description("The id of the database.") String id,
@Description("The name of the database.") String name,
@Description("The creation date of the database, formatted according to the ISO-8601 Standard.")
String creationDate) {}
public static class RelationshipTypeResult {
@Description("A relationship type in the database.")
public final String relationshipType;
private RelationshipTypeResult(RelationshipType relationshipType) {
this.relationshipType = relationshipType.name();
}
}
public record BooleanResult(
@Description("Whether or not the connection call to the database has been successful.") Boolean success) {}
public record NodeResult(Node node) {}
public record WeightedNodeResult(Node node, double weight) {}
public record WeightedRelationshipResult(Relationship relationship, double weight) {}
public record RelationshipResult(Relationship relationship) {}
}