must refer to a CONNECTION section in the client nucleus.ini file that contains the Host and Port information used by the Load Balancer (specified in the ssa.ini file). When connecting to a running Nucleus database instance or Data Vault repository database,
connection-name
must be the name of the connection used to start
instance-name
.
The
connection-name
argument is optional, but must be entered in order to connect automatically to a Nucleus instance or Data Vault repository database. If ssasql is being used to connect to a database instance running on a remote server, the client-side nucleus.ini file must contain a [CONNECTION
connection-name
] section that specifies the port number and host name used to connect to the database instance, and these must match the values specified for the same connection in the server-side nucleus.ini file. The connection name is not case-sensitive.
By default, the maximum number of client programs that may use a particular connection is
10
(this limit may be changed by including a MaxUsers entry in the appropriate CONNECTION section of the server-side nucleus.ini file).
instance-name
The name of the Data Vault repository database or Nucleus database instance to which to connect. The
instance-name
argument is optional. It must be entered, however, if a
connection-name
argument has been specified.
Instance-name
must have already been started with the specified connection. The instance name is not case-sensitive.
user-name
The
user-name
argument is optional. It is required, however, if
connection-name
and
instance-name
arguments are entered. The
user-name
argument must specify a valid user authorization in the specified database. The user name is not case-sensitive.
/user-password
The
user-password
argument is required only if a
user-name
argument is entered, and if the specified user authorization has an associated password. The
user-password
argument must be separated from the
user-name
argument only by a slash character (
/
); no “white space” may appear between the two arguments. The password must precisely match the password associated with the specified user authorization.
User passwords are case-sensitive.
flags
The optional flags described below may be specified individually, or in combination (if multiple flags are specified, they must be separated by spaces). When the flag includes an argument, these elements cannot be separated by any “white space”.
-h or -?
The
-h
(or
-?
) flag displays a help screen which describes the ssasql invocation flags and arguments.
-f
file-name
The
-f
flag lets the user specify a name and location for the session log file created through the .OUTPUT system command. By default, the log file is called
inter.out
and is created in the current working directory. If the full path to the log file contains any spaces, put quotation marks around the path. If only the file name is specified (that is, the path location is omitted), the file is created in the current directory.
-o{0 | 1}
The -
o
flag turns the session logging off (0) or on (1). The default setting is “off” (that is,
-o0
). The
-o1
flag turns session logging on, and creates a file with the name
inter.out
, in which all ssasql input and output will be recorded. The inter.out file is always created in the current directory and overwrites any existing inter.out file.
-p{0 | 1}
The
-p
flag turns the ssasql command prompt off (0) or on (1). The default setting is “on”, that is,
-p1
. Include the
-p0
flag in the invocation in order to turn off the prompt display.
-t{0 | 1}
The
-t
flag turns the title list display off (0) or on (1). The default setting is “on”, that is,
-t1
. Include the
-t0
flag in the invocation in order to suppress the display of the column headings returned by SQL SELECT statements.
-w{0 | 1}
The
-w
flag turns the SQL warning message display off (0) or on (1). The default setting is “on”, that is,
-w1
. Include the
-w0
flag in the invocation in order to suppress the display of SQL warning messages.