org.neo4j.shell.kernel.apps.cypher.Explain Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-shell Show documentation

A generic command shell with a client and server part.

There is a newer version: 3.3.2

/*
 * Copyright (c) 2002-2016 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.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.shell.kernel.apps.cypher;

import org.neo4j.helpers.Service;
import org.neo4j.shell.App;

@Service.Implementation(App.class)
public class Explain extends Start
{
    @Override
    public String getDescription()
    {
        return "Without executing a query, shows the execution plan that would be used for a given query." +
                "Usage: explain \n" +
                "Example: EXPLAIN MATCH (me)-[:KNOWS]->(you) RETURN you.name\n" +
                "would show the execution plan used for that query.";
    }
}