org.neo4j.exceptions.IndexHintException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-exceptions Show documentation
Neo4j exceptions
There is a newer version: 5.25.1
/*
 * 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.exceptions;

import java.util.List;
import java.util.stream.Collectors;
import org.neo4j.common.EntityType;
import org.neo4j.gqlstatus.ErrorGqlStatusObject;
import org.neo4j.kernel.api.exceptions.Status;

/**
 * A hint was used referring to an index that does not exist.
 */
public class IndexHintException extends Neo4jException {
    public enum IndexHintIndexType {
        ANY,
        BTREE,
        TEXT,
        RANGE,
        POINT
    }

    public IndexHintException(
            String variableName,
            String labelOrRelType,
            List properties,
            EntityType entityType,
            IndexHintIndexType indexType) {
        super(msg(variableName, labelOrRelType, properties, entityType, indexType));
    }

    public IndexHintException(
            ErrorGqlStatusObject gqlStatusObject,
            String variableName,
            String labelOrRelType,
            List properties,
            EntityType entityType,
            IndexHintIndexType indexType) {
        super(gqlStatusObject, msg(variableName, labelOrRelType, properties, entityType, indexType));
    }

    @Override
    public Status status() {
        return Status.Schema.IndexNotFound;
    }

    private static String msg(
            String variableName,
            String labelOrRelType,
            List properties,
            EntityType entityType,
            IndexHintIndexType indexType) {
        return String.format(
                "No such index: %s",
                indexFormatString(variableName, labelOrRelType, properties, entityType, indexType));
    }

    public static String indexFormatString(
            String variableName,
            String labelOrRelType,
            List properties,
            EntityType entityType,
            IndexHintIndexType indexType) {
        String escapedVarName = escape(variableName);

        String escapedLabelOrRelTypeName = escape(labelOrRelType);

        String propertyNames = properties.stream()
                .map(propertyName -> escapedVarName + "." + escape(propertyName))
                .collect(Collectors.joining(", "));

        String typeString =
                switch (indexType) {
                    case BTREE -> "BTREE ";
                    case TEXT -> "TEXT ";
                    case RANGE -> "RANGE ";
                    case POINT -> "POINT ";
                    default -> "";
                };

        return switch (entityType) {
            case NODE -> String.format(
                    "%sINDEX FOR (%s:%s) ON (%s)",
                    typeString, escapedVarName, escapedLabelOrRelTypeName, propertyNames);
            case RELATIONSHIP -> String.format(
                    "%sINDEX FOR ()-[%s:%s]-() ON (%s)",
                    typeString, escapedVarName, escapedLabelOrRelTypeName, propertyNames);
        };
    }

    private static String escape(String str) {
        return "`" + str.replace("`", "``") + "`";
    }
}