org.neo4j.shell

Class StartClient

java.lang.Object

org.neo4j.shell.StartClient

public class StartClient
extends Object

Can start clients, either remotely to another JVM running a server or by starting a local GraphDatabaseShellServer in this JVM and connecting to it.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARG_COMMAND Commands (a line can contain more than one command, with && in between) to execute when the shell client has been connected.
static String	ARG_CONFIG Configuration file to load and use if a local GraphDatabaseService is started in this JVM.
static String	ARG_FILE File a file with shell commands to execute when the shell client has been connected.
static String	ARG_FILE_STDIN Special character used to request reading from stdin rather than a file.
static String	ARG_HOST The host (ip or name) to connect remotely to.
static String	ARG_NAME The RMI name to use.
static String	ARG_PATH The path to the local (this JVM) GraphDatabaseService to start and connect to.
static String	ARG_PID The PID (process ID) to connect to.
static String	ARG_PORT The port to connect remotely on.
static String	ARG_READONLY Whether or not the shell client should be readonly.
static String	ARG_VERSION Prints the version and edition of neo4j and exits.

Method Summary

Modifier and Type	Method and Description
static void	main(String[] arguments) Starts a shell client.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ARG_VERSION

public static final String ARG_VERSION

Prints the version and edition of neo4j and exits.

See Also:

Constant Field Values

ARG_PATH

public static final String ARG_PATH

The path to the local (this JVM) GraphDatabaseService to start and connect to.

See Also:

Constant Field Values

ARG_READONLY

public static final String ARG_READONLY

Whether or not the shell client should be readonly.

See Also:

Constant Field Values

ARG_HOST

public static final String ARG_HOST

The host (ip or name) to connect remotely to.

See Also:

Constant Field Values

ARG_PORT

public static final String ARG_PORT

The port to connect remotely on. A server must have been started on that port.

See Also:

Constant Field Values

ARG_NAME

public static final String ARG_NAME

The RMI name to use.

See Also:

Constant Field Values

ARG_PID

public static final String ARG_PID

The PID (process ID) to connect to.

See Also:

Constant Field Values

ARG_COMMAND

public static final String ARG_COMMAND

Commands (a line can contain more than one command, with && in between) to execute when the shell client has been connected.

See Also:

Constant Field Values

ARG_FILE

public static final String ARG_FILE

File a file with shell commands to execute when the shell client has been connected.

See Also:

Constant Field Values

ARG_FILE_STDIN

public static final String ARG_FILE_STDIN

Special character used to request reading from stdin rather than a file. Uses the dash character, which is a common way to specify this.

See Also:

Constant Field Values

ARG_CONFIG

public static final String ARG_CONFIG

Configuration file to load and use if a local GraphDatabaseService is started in this JVM.

See Also:

Constant Field Values

Method Detail

main

public static void main(String[] arguments)

Starts a shell client. Remote or local depending on the arguments.

Parameters:

arguments - the arguments from the command line. Can contain information about whether to start a local GraphDatabaseShellServer or connect to an already running GraphDatabaseService.