org.neo4j.procedure.builtin.TokenProcedures 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

Neo4j Community Procedures.

There is a newer version: 5.23.0

/*
 * 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 .
 */
package org.neo4j.procedure.builtin;

import static org.neo4j.procedure.Mode.WRITE;

import org.neo4j.exceptions.KernelException;
import org.neo4j.kernel.api.KernelTransaction;
import org.neo4j.procedure.Context;
import org.neo4j.procedure.Description;
import org.neo4j.procedure.Name;
import org.neo4j.procedure.Procedure;

public class TokenProcedures {
    @Context
    public KernelTransaction tx;

    @Description("Create a label")
    @Procedure(name = "db.createLabel", mode = WRITE)
    public void createLabel(@Name(value = "newLabel", description = "Label name.") String newLabel)
            throws KernelException {
        tx.tokenWrite().labelGetOrCreateForName(newLabel);
    }

    @Description("Create a RelationshipType")
    @Procedure(name = "db.createRelationshipType", mode = WRITE)
    public void createRelationshipType(
            @Name(value = "newRelationshipType", description = "Relationship type name.") String newRelationshipType)
            throws KernelException {
        tx.tokenWrite().relationshipTypeGetOrCreateForName(newRelationshipType);
    }

    @Description("Create a Property")
    @Procedure(name = "db.createProperty", mode = WRITE)
    public void createProperty(@Name(value = "newProperty", description = "Property name.") String newProperty)
            throws KernelException {
        tx.tokenWrite().propertyKeyGetOrCreateForName(newProperty);
    }
}