Skip to content
≡

Administrator

Developer

Tools

External Tools

iSQL Command-Line Options

iSQL Command-Line Options#

The Altibase server must be started before iSQL is executed. The following options are case-insensitive.

isql
[-H]
[-S server_name]
[-PORT port_no]
[-U user_id] [-P password] [/NOLOG]
[-SYSDBA]
[-UNIXDOMAIN-FILEPATH filepath]
[-IPC-FILEPATH filepath]
[-SILENT]
[-F infile_name [param1 [param2]...]] [-O outfile_name] [-NLS_USE nls_name]
[-NLS_NCHAR_LITERAL_REPLACE 0|1]
[-prefer_ipv6] [-TIME_ZONE timezone]
[-ssl_ca CA_file_path | -ssl_capath CA_dir_path]
[-ssl_cert certificate_file_path]
[-ssl_key key_file_path]
[-ssl_verify]
[-ssl_cipher cipher_list]

-S server_name#

This option specifies the name (or IP address) of a computer on which Altibase Server is running.

If connection is attempted while the ISQL_CONNECTION environment variable is set to IPC or UNIX, and the remote server is specified for this option, iSQL ignores the ISQL_CONNECTION specification and connects to the remote server via TCP, and outputs a warning message that the ISQL_CONNECTION specification has been ignored. It can be a host name, an IPv4 address, or an IPv6 address. An IPv6 address must be enclosed by a left square bracket([) and a right square bracket(]). For example, in the case of localhost (meaning this computer), localhost can be specified as the host name, 127.0.0.1 as the IPv4 address, or [::1] as the IPv6 address.

For more information about the IPv6 address notation, please refer to the Altibase Administrator's Manual.

-PORT port_no#

This option specifies the port number for connecting via TCP, IPC or IPCDA. However, when connecting in a Unix environment via IPC, this option must not be specified.

After a warning message is output, connection to the server is made. To connect via TCP, first set 'ISQL_CONNECTION=TCP' on the client and then enter the PORT_NO. If the environment variable ISQL_CONNECTION is not set to IPC and the -PORT option is omitted, ALTIBASE_PORT_NO and PORT_NO property is referred in sequence. However, the prompt for port number input is output if all is not specified.

-U user_id#

This option specifies a user ID registered in the database.

-P password#

This option specifies the password corresponding to the user ID.

/NOLOG#

This executes iSQL without connecting to the database.

-SYSDBA#

This allows the SYS user to execute iSQL in SYSDBA mode. If the server has not yet started, iSQL connects as an idle instance and allows the user to start the server.

-UNIXDOMAIN-FILEPATH filepath#

When a server and client connect using a Unix domain socket in a Unix environment (ISQL_CONNECTION=UNIX), the connection will fail if the server and client have different values for ALTIBASE_HOME and also have different Unix domain socket paths. In this case, if the server and client use corresponding files (e.g. ALTIBASE_HOME/trc/cm-unix), Unix domain communication is possible.

-IPC-FILEPATH filepath#

When the client and the server connect via IPC(ISQL_CONNECTION=IPC) in a Unix environment, if ALTIBASE_HOME is set differently on them, they will not be able to connect because they have different socket paths. In this case, Unix domain communication can be achived using the ALTIBASE_HOME/trc/cm-ipc file, and then information about shared memory can be retrieved. However, this option can be omitted if ALTIBASE_IPC_FILEPATH is set.

-IPCDA-FILEPATH filepath#

If ALTIBASE_HOME is different from each other when attempting to connect the client and server via IPCDA (ISQL_CONNECTION=IPCDA), the connection cannot be made due to different socket paths Howeve, if ALTIBASE_HOME/trc/cm-ipcda file is used, the Unix domain communication is enabled to bring the information of shared memory. However, this option can be omitted if IPCDA_FILEPATH of environment variables is specified.

-F infile_name [param1 [param2]...]#

This command option specifies a script file to be executed immediately after iSQL is launched. Use double quotation marks if the file name contains special characters or spaces.

e.g., -F \\" file name\\"

This command also can specify a paramater value which will be substituted for a substitution variable in the script file. Refer to the 'Passing parameters through START command' for more information regarding the substitution variables.

-O outfile_name#

This command option specifies a file in which to store the results of the excuted iSQL commands. This file will be created in the current directory. If the file already exists, it will be overwritten.

Use double quotation marks if the file name contains special characters or spaces.

e.g., -O \\" file name\\"

-H#

This option outputs help information for iSQL execution.

-SILENT s#

This option turns on silent mode. If silent mode is on, noncritical messages, such as the copyright notice, etc. will not be displayed.

-NLS_USE#

Character set to display to user when searching data.

This specifies the encoding of the terminal running iSQL. If omitted, the environment variable ALTIBASE_NLS_USE will be referred to, followed by altibase.properties. If not set, the default charset (US7ASCII) is used.

  • US7ASCII
  • KO16KSC5601
  • MS949
  • BIG5
  • GB231280
  • MS936
  • UTF8
  • SHIFTJIS
  • MS932

EUCJP-NLS_NCHAR_LITERAL_REPLACE#

  • 0 : convert all strings to the database character set without checking for the "N" character.
  • 1 : do not convert strings that are preceded by the "N" character to the database character set

-prefer_ipv6#

This option determines the IP address to be connected first when a host name is given for the -s option.
If this option is specified and a host name is given for the -s option, this means that resolving the host name to the IPv6 address is prefered. If this option is omitted, iSQL connects to the IPv4 address by default. If it fails to connect to the prefered IP version address, an attempt is made to connect using the other IP version address.
For example, when localhost is given for the -s option and this option is specified, iSQL first tries to connect to the [::1] IPv6 address. If this attempt fails, iSQL proceeds to connect to the 127.0.0.1 IPv4 address.

-TIME_ZONE timezone#

This option sets the time zone of the client. If DB_TZ is specified for this option, the time zone is defaulted to that of the database server. Time zone names like Asia/Seoul, abbreviations such as KST and UTC offset values as +09:00 are valid for specification.
If this option is omitted, the time zone set for the ALTIBASE_TIME_ZONE environment variable is defaulted to the time zone of the client; on omission of the environment variable, the time zone is defaulted to that of the database server.

-ssl_ca CA_file_path#

This specifies the location of the certification authority (CA) certificate in which the public key of the Altibase server to be connected to is incorporated.

-ssl_capath CA_dir_path#

This specifies the directory under which the certification authority (CA) certificate in which the public key of the Altibase server to be connected is incorporated.

-ssl_cert certificate_file_path#

This specifies the location of the client authentication file.

-ssl_key key_file_path#

This specifies the location of the client private key file.

-ssl_verify#

This verifies the certificate the client receives from the server.

-ssl_cipher cipher_list#

This specifies a cipher list for SSL encryption. Please refer to the SSL_CIPHER_LIST property in the General Reference.

If any of the -S, -U, or -P options are missing from the above command, the user will be prompted to input the option values.