Skip to main content

Connecting to a Caché Instance

Connecting to a Caché Instance

Once you have started Caché, you can log into Caché on the command line using the csession command, as follows:

csession <instname> [arguments]

where instname is the name of the instance that you are managing, and [arguments] indicates one or more of the optional arguments described in the following table. On a Windows system, you must execute the command from its location, the install-dir\bin directory of a Caché instance, or include the full path in the command, for example:

C:\InterSystems\Cache27\bin\csession Cache33
Note:

As shown in the preceding example, the instance name you specify can be different from the instance of the csession binary you are executing, but is always required, even if they are the same.

Caché csession Command and Arguments
Command Description
csession instname -B

Provides system administrator emergency login.

Note:

To execute an emergency startup on Windows, you must open the Command Prompt using the Run as Administrator option. See also Emergency Access in the “System Management and Security” chapter of the Caché Security Administration Guide for information about starting and logging into Caché in emergency access mode.

csession instname -U namespace Specifies the login namespace.
Note:

-U has no effect if you are starting Caché with a user account whose Startup Namespace is specified (see Properties of Users in the “Users” chapter of the Caché Security Administration Guide).

csession instname -b partition_size Specifies the maximum partition size (in KB) for the process.
csession instname "[label[+offset]]^routine"

Specifies the name of an ObjectScript program to run in user mode.

In addition to the specified formats, you can pass parameter lists consisting of string and/or numeric literals, as well as omitted (void) parameters, as follows:

  • "routine[([parameter-list])]"

  • "[label]^routine[([parameter-list])]"

  • "##CLASS(package.class).method[([parameter-list])]"

where, for example, parameter-list is specified in the form "string literal",,-+-000123.45600E+07, and omitted parameters are passed to the target as $Data(parameter)=0.

Note:

Whitespace and shell meta characters must be quoted in an operating-system dependent form.

To use the csession command or the ccontrol command (see Controlling Caché Instances) on a remote server, use csession or Terminal, or a remote connection through Terminal or Telnet/ssh client.

FeedbackOpens in a new tab