CUBRID 10.0 User Manual¶

Supported Platforms and System Requirements¶

The platforms supported by CUBRID and hardware/software requirements for the installation are as follows:

(*): Requires a 500 MB of free disk space on the initial installation; requires approximately 1.5 GB of free disk space with a database creating with default options.

Beginning with 2008 R4.0, CUBRID Manager Client is not automatically installed when installing the CUBRID package. For this reason, if you require CUBRID Manager you must install it separately. The CUBRID can be downloaded from http://ftp.cubrid.org.

Including CUBRID Query Browser, a variety of drivers such as PHP, ODBC and OLE DB can also be downloaded from http://ftp.cubrid.org.

For more information on the CUBRID engine, tools, and drivers, see http://www.cubrid.org.

Compatibility¶

Application Compatibility

• Applications that use JDBC, PHP or CCI APIs from 2008 R4.1 or higher version of CUBRID can access the CUBRID 10.0 database. However, you must link the CUBRID 10.0 library or use the driver to use the added/improved features of JDBC, PHP or CCI interfaces. In order to use Date/Time Types with Timezone which are introduced as 10.0, users should upgrade drivers.
• Note that query results may differ from those given in the earlier version because new reserved words have been added, and the specifications for some queries have been changed.
• An application that is developed by using the GLO class can be used after it is converted to an application or schema suitable to the BLOB or CLOB type.

CUBRID Manager Compatibility

• CUBRID Manager guarantees backward compatibility with the servers using CUBRID 2008 R2.2 or higher and uses the CUBRID JDBC driver that matches each server version. However, you must use a CUBRID Manager that is higher than CUBRID servers in version in order to utilize all the features of CUBRID Manager. The CUBRID JDBC driver is included in the $CUBRID/jdbc directory when CUBRID is installed($CUBRID on Linux, %CUBRID% on Windows).

• The bit version of CUBRID Manager must be identical to the bit version of JRE.

  For example, if a 64-bit DB server uses CUBRID Manager 32-bit version, JRE or JDK 32-bit version should be installed.

• Drivers for 2008 R2.2 and higher versions are included in CUBRID Manager by default, which you can download separately from the http://www.cubrid.org Website.

Interoperability between CUBRID DB server and broker

• If the CUBRID DB server and its broker server are operated separately, CUBRID version between them should be the same, but if just the patch version is different, their interoperability is guaranteed.

  For example, 2008 R4.1 Patch1 broker is compatible with 2008 R4.1 Patch 10 DB server, but not compatible with 2008 R4.3 DB server. 9.1 Patch 1 broker is compatible with 9.1 Patch 10 DB server, but not compatible with 9.2 DB server.

• Even if the operating systems are different, their interoperability is guaranteed if the bit version of a DB server is identical to the bit version of a broker server.

  For example, the 64-bit DB server for Linux is interoperable with the 64-bit broker server for Windows, but it is not interoperable with a 32-bit broker server.

  For the relation between DB server and broker, see Introduction to CUBRID.

Installing and Running CUBRID on Linux¶

Checklist before Installing

Check the following before installing CUBRID for Linux.

• glibc version

  Only supports glibc 2.3.4 or later. The glibc version can be checked as follows:

  %rpm -q glibc
  

• 64-bit or 32-bit

  As 10.0, CUBRID supports only 64-bit Linux. You can check the version as follows:

  % uname -a
  Linux host_name 2.6.18-53.1.14.el5xen #1 SMP Wed Mar 5 12:08:17 EST 2008 x86_64 x86_64 x86_64 GNU/Linux
  

  Make sure to install the CUBRID 64-bit version on 64-bit Linux.

• The libraries that should be added.

  • Curses Library (rpm -q ncurses)
  • gcrypt Library (rpm -q libgcrypt)
  • stdc++ Library (rpm -q libstdc++)

• Check if the mapping between host names and IP addresses are correct in the /etc/hosts file.

  If host names and IP addresses are matched incorrectly, DB server cannot be started normally. Therefore, check if they are correctly mapped.

Installing CUBRID

The installation program consists of shell scripts that contain binary; thus it can be installed automatically. The following example shows how to install CUBRID with the "CUBRID-10.0.0.1376-linux.x86_64.sh" file on the Linux.

$ sh CUBRID-10.0.0.1376-linux.x86_64.sh
Do you agree to the above license terms? (yes or no) : yes
Do you want to install this software(CUBRID) to the default(/home1/cub_user/CUBRID) directory? (yes or no) [Default: yes] : yes
Install CUBRID to '/home1/cub_user/CUBRID' ...
In case a different version of the CUBRID product is being used in other machines,
please note that the CUBRID 10.0 servers are only compatible with the CUBRID 10.0 clients and vice versa.
Do you want to continue? (yes or no) [Default: yes] : yes
Copying old .cubrid.sh to .cubrid.sh.bak ...

CUBRID has been successfully installed.

demodb has been successfully created.

If you want to use CUBRID, run the following commands
$ . /home1/cub_user/.cubrid.sh
$ cubrid service start

As shown in the example above, after installing the downloaded file (CUBRID-10.0.0.1376-linux.x86_64.sh), the CUBRID related environment variables must be set in order to use the CUBRID database. Such setting has been made automatically when logging in the concerned terminal. Therefore there is no need to re-set after the first installation.

$ . /home1/cub_user/.cubrid.sh

After CUBRID is installed, you can start CUBRID Manager server and CUBRID broker as follows.

$ cubrid service start

When you want to check whether CUBRID Manager server and CUBRID broker works well, you can use grep command in Linux as follows.

$ ps -ef | grep cub_
cub_user 15200 1 0 18:57   00:00:00 cub_master
cub_user 15205 1 0 18:57 pts/17 00:00:00 cub_broker
cub_user 15210 1 0 18:57 pts/17 00:00:00 query_editor_cub_cas_1
cub_user 15211 1 0 18:57 pts/17 00:00:00 query_editor_cub_cas_2
cub_user 15212 1 0 18:57 pts/17 00:00:00 query_editor_cub_cas_3
cub_user 15213 1 0 18:57 pts/17 00:00:00 query_editor_cub_cas_4
cub_user 15214 1 0 18:57 pts/17 00:00:00 query_editor_cub_cas_5
cub_user 15217 1 0 18:57 pts/17 00:00:00 cub_broker
cub_user 15222 1 0 18:57 pts/17 00:00:00 broker1_cub_cas_1
cub_user 15223 1 0 18:57 pts/17 00:00:00 broker1_cub_cas_2
cub_user 15224 1 0 18:57 pts/17 00:00:00 broker1_cub_cas_3
cub_user 15225 1 0 18:57 pts/17 00:00:00 broker1_cub_cas_4
cub_user 15226 1 0 18:57 pts/17 00:00:00 broker1_cub_cas_5
cub_user 15229 1 0 18:57   00:00:00 cub_auto start
cub_user 15232 1 0 18:57   00:00:00 cub_js start

Installing CUBRID (rpm File)

You can install CUBRID by using rpm file that is created on CentOS 5. The way of installing and uninstalling CUBRID is the same as that of using general rpm utility. While CUBRID is being installed, a new system group (cubrid) and a user account (cubrid) are created. After installation is complete, you should log in with a cubrid user account to start a CUBRID service.:

$ rpm -Uvh cubrid-10.0.0.1376-el5.x86_64.rpm

When rpm is executed, CUBRID is installed in the "cubrid" home directory (/opt/cubrid) and related configuration file (cubrid.[c]sh) is installed in the /etc/profile.d directory. Note that demodb is not automatically installed. Therefore, you must executed /opt/cubrid/demo/make_cubrid_demo.sh with "cubrid" Linux ID. When installation is complete, enter the code below to start CUBRID with "cubrid" Linux ID.

$ cubrid service start

Upgrading CUBRID

When you specify an installation directory where the previous version of CUBRID is already installed, a message which asks to overwrite files in the directory will appear. Entering no will stop the installation.

Directory '/home1/cub_user/CUBRID' exist!
If a CUBRID service is running on this directory, it may be terminated abnormally.
And if you don't have right access permission on this directory(subdirectories or files), install operation will be failed.
Overwrite anyway? (yes or no) [Default: no] : yes

Choose whether to overwrite the existing configuration files during the CUBRID installation. Entering yes will overwrite and back up them as extension .bak files.

The configuration file (.conf or .pass) already exists. Do you want to overwrite it? (yes or no) : yes

For more information on upgrading a database from a previous version to a new version, see Upgrade.

Configuring Environment

You can modify the environment such as service ports etc. edit the parameters of a configuration file located in the $CUBRID/conf directory. See Installing and Running CUBRID on Windows for more information.

Installing CUBRID Interfaces

You can see the latest information on interface modules such as CCI, JDBC, PHP, ODBC, OLE DB, ADO.NET, Ruby, Python and Node.js and install them by downloading files from http://www.cubrid.org/wiki_apis.

A simple description on each driver can be found on API Reference.

Installing CUBRID Tools

You can see the latest information on tools such as CUBRID Manager and CUBRID Query Browser and install them by downloading files from http://www.cubrid.org/wiki_tools.

CUBRID Web Manager is also installed when the CUBRID is installed. For more details, see CUBRID Web Manager Manual.

Installing and Running CUBRID on Windows¶

Checklist before Installing

You should check the below before installing CUBRID for Windows.

• 64-bit or not

  CUBRID supports both 32-bit and 64-bit Windows. You can check the version by selecting [My Computer] > [System Properties]. Make sure to install the CUBRID 32-bit version on 32-bit Windows and the CUBRID 64-bit version on 64-bit Windows.

• Run with administrative privilege

  If you want to install CUBRID on Windows Vista or higher, execute the installation file with administrative privileges. On the popup menu after clicking right mouse button on the CUBRID installation file, choose [Execute as an administrator (A)].

Installation Process

Step 1: Specifying the directory to install

Step 2: Selecting Setup Type

• Server and Driver Installation : All of CUBRID Server, CSQL (a command line tool) and interface drivers (JDBC, C API) are installed.

Step 3: Creating a sample database

To create a sample database, it requires 300MB disk space.

Step 4: Completing the installation

CUBRID Service Tray appears on the right bottom.

Checklist After Installation

• Whether the start of CUBRID Service Tray or not

  If CUBRID Service Tray is not automatically started when starting a system, confirm the following.

  • Check if Task Scheduler is started in [Start button] > [Control panel] > [Administrative Tools] > [Services]; if not, start Task Scheduler.
  • Check if CUBRID Service Tray is registered in [Start button] > [All Programs] > [Startup]; if not, register CUBRID Service Tray.

Upgrading CUBRID

To install a new version of CUBRID in an environment in which a previous version has already been installed, select [CUBRID Service Tray] > [Exit] from the menu to stop currently running services, and then remove the previous version of CUBRID. Note that when you are prompted with "Do you want to delete all the existing version of databases and the configuration files?" you must select "No" to protect the existing databases.

For more information on upgrading a database from a previous version to a new version, see Upgrade.

Configuring Environment

You can change configuration such as service ports to meet the user environment by changing the parameter values of following files which are located in the %CUBRID%\conf directory. If a firewall has been configured, the ports used in CUBRID need to be opened.

• cm.conf

  A configuration file for CUBRID Manager. The port that the Manager server process uses is called cm_port and its default value is 8001. For details, see CUBRID Manager Manual.

  To start CUBRID Web Manager, firstly you should set the value of support_web_manager parameter as "YES", then restart CUBRID Manager Server. To use CUBRID Web Manager, access "https://localhost:8001".

  $ cubrid manager stop
  $ cubrid manager start
  

• cubrid.conf

  A configuration file for server. You can use it to configure the following values: database memory, the number threads based on the number of concurrent users, communication port between broker and server, etc. The port that a master process uses is called cubrid_port_id and its default value is 1523. For details, see cubrid.conf Configuration File and Default Parameters.

• cubrid_broker.conf

  A configuration file for broker. You can use it to configure the following values: broker port, the number of application servers (CAS), SQL LOG, etc. The port that a broker uses is called BROKER_PORT. A port you see in the drivers such as JDBC is its corresponding broker's port. APPL_SERVER_PORT is a port that a broker application server (CAS) uses and it is added only in Windows. The default value is BROKER_PORT +1. The number of ports used is the same as the number of CAS, starting from the specified port's number plus 1. For details, see Parameter by Broker. For example, if the value of APPL_SERVER_PORT is 35000 and the maximum number of CASes by MAX_NUM_APPL_SERVER is 50, then listening ports on CASes are 35000, 35001, ..., 35049. For more details, see Parameter by Broker.

  The CCI_DEFAULT_AUTOCOMMIT broker parameter is supported since 2008 R4.0. The default value in the version is OFF and it is later changed to ON. Therefore, users who have upgraded from 2008 R4.0 to 2008 R4.1 or later versions should change this value to OFF or configure the auto-commit mode to OFF.

Installing CUBRID Interfaces

You can see the latest information on interface modules such as JDBC, PHP, ODBC, and OLE DB and install them by downloading files from http://www.cubrid.org/wiki_apis.

A simple description on each driver can be found on API Reference.

Installing CUBRID Tools

You can see the latest information on tools such as CUBRID Manager and CUBRID Query Browser and install them by downloading files from http://www.cubrid.org/wiki_tools.

CUBRID Web Manager is installed when CUBRID is installed. For more details, see CUBRID Web Manager Manual .

Installing with a Compressed Package¶

CUBRID Environment Variables¶

• CUBRID: The default environment variable that designates the location where the CUBRID is installed. This variable must be set accurately since all programs included in the CUBRID system uses this environment variable as reference.
• CUBRID_DATABASES: The environment variable that designates the location of the databases.txt file. The CUBRID system stores the absolute path of database volumes in the $CUBRID_DATABASES/databases.txt file. See databases.txt File.
• CUBRID_MSG_LANG: The environment variable that specifies usage messages and error messages in CUBRID. The initial value upon start is not defined. If it is not defined, it follows the configured locale when createdb. For more information, see Language & Charset Setting.

• CUBRID_TMP: The environment variable that specifies the location where the cub_master process and the cub_broker process store the UNIX domain socket file in CUBRID for Linux. If it is not specified, the cub_master process stores the UNIX domain socket file under the /tmp directory and the cub_broker process stores the UNIX domain socket file under the $CUBRID/var/CUBRID_SOCK directory (not used in CUBRID for Windows).

CUBRID_TMP value has some constraints, which are as follows:

• Since the maximum length of the UNIX socket path is 108, when a path longer than 108 is entered in $CUBRID_TMP, an error is displayed.

  $ export CUBRID_TMP=/home1/testusr/cubrid=/tmp/123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789
  $ cubrid server start apricot
  
  The $CUBRID_TMP is too long. (/home1/testusr/cubrid=/tmp/123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789)
  

• When the relative path is entered, an error is displayed.

  $ export CUBRID_TMP=./var
  $ cubrid server start testdb
  
  The $CUBRID_TMP should be an absolute path. (./var)
  

CUBRID_TMP can be used to avoid the following problems that can occur at the default path of the UNIX domain socket that CUBRID uses.

• /tmp is used to store the temporary files in Linux. If the system administrator periodically and voluntarily cleans the space, the UNIX domain socket may be removed. In this case, configure $CUBRID_TMP to another path, not /tmp.
• The maximum length of the UNIX socket path is 108. When the installation path of CUBRID is too long and the $CUBRID/var/CUBRID_SOCK path that store the UNIX socket path for cub_broker exceeds 108 characters, the broker cannot be executed. Therefore, the path of $CUBRID_TMP must not exceed 1008 characters.

The above mentioned environment variables are set when the CUBRID is installed. However, the following commands can be used to verify the setting.

• Linux

  % printenv CUBRID
  % printenv CUBRID_DATABASES
  % printenv CUBRID_MSG_LANG
  % printenv CUBRID TMP
  

• Windows

  C:\> set CUBRID
  

OS Environment and Java Environment Variables¶

• PATH: In the Linux environment, the directory $CUBRID/bin, which includes a CUBRID system executable file, must be included in the PATH environment variable.
• LD_LIBRARY_PATH: In the Linux environment, $CUBRID/lib, which is the CUBRID system's dynamic library file (libjvm.so), must be included in the LD_LIBRARY_PATH (or SHLIB_PATH or LIBPATH) environment variable.
• Path: In the Windows environment, the %CUBRID%\bin, which is a directory that contains CUBRID system's execution file, must be included in the Path environment variable.
• JAVA_HOME: To use the Java stored procedure in the CUBRID system, the Java Virtual Machine (JVM) version 1.6 or later must be installed, and the JAVA_HOME environment variable must designate the concerned directory. See the Environment Configuration for Java Stored Function/Procedure.

Configuring the Environment Variable¶

For Windows

If the CUBRID system has been installed on Windows, then the installation program automatically sets the necessary environment variable. Select [Systems Properties] in [My Computer] and select the [Advanced] tab. Click the [Environment Variable] button and check the setting in the [System Variable]. The settings can be changed by clicking on the [Edit] button. See the Windows help for more information on how to change the environment variable on Windows.

For Linux

If the CUBRID system has been installed on Linux, the installation program automatically creates the .cubrid.sh or .cubrid.csh file and makes configurations so that the files are automatically called from the installation account's shell log-in script. The following is the contents of . cubrid.sh environment variable configuration that was created in an environment that uses sh, bash, etc.

CUBRID=/home1/cub_user/CUBRID
CUBRID_DATABASES=/home1/cub_user/CUBRID/databases
ld_lib_path=`printenv LD_LIBRARY_PATH`

if [ "$ld_lib_path" = "" ]
then
    LD_LIBRARY_PATH=$CUBRID/lib
else
    LD_LIBRARY_PATH=$CUBRID/lib:$LD_LIBRARY_PATH
fi

SHLIB_PATH=$LD_LIBRARY_PATH
LIBPATH=$LD_LIBRARY_PATH
PATH=$CUBRID/bin:$CUBRID/cubridmanager:$PATH

export CUBRID
export CUBRID_DATABASES
export LD_LIBRARY_PATH
export SHLIB_PATH
export LIBPATH
export PATH

Language & Charset Setting¶

The language and the charset that will be used in the CUBRID DBMS is specified after the database name when DB is created(e.g. cubrid createdb testdb ko_KR.utf8). The following are examples of values that can currently be set as a language and a charset.

• en_US.iso88591: English ISO-88591 encoding(.iso88591 can be omitted)
• ko_KR.euckr: Korean EUC-KR encoding
• ko_KR.utf8: Korean UTF-8 encoding(.utf8 can be omitted)
• de_DE.utf8: German UTF-8 encoding
• es_ES.utf8: Spanish UTF-8 encoding
• fr_FR.utf8: French UTF-8 encoding
• it_IT.utf8: Italian UTF-8 encoding
• ja_JP.utf8: Japanese UTF-8 encoding
• km_KH.utf8: Cambodian UTF-8 encoding
• tr_TR.utf8: Turkish UTF-8 encoding(.utf8 can be omitted)
• vi_VN.utf8: Vietnamese UTF-8 encoding
• zh_CN.utf8: Chinese UTF-8 encoding
• ro_RO.utf8: Romanian UTF-8 encoding

Language and charset setting of CUBRID affects read and write data. The language is used for messages displayed by the program.

For more details related to charset, locale and collation settings, see An Overview of Globalization.

Default Ports for CUBRID¶

The following table summarizes the ports required for each OS, based on the listening processes. Each port on the listener should be opened.

(*): The machine which has the CAS or CSQL process

(**): The machine which has the cub_server

As the server process (cub_server) and the client processes (CAS, CSQL) cross-check if the opposite node is normally running or not by using the ECHO(7) port, you should open the ECHO(7) port if there is a firewall. If the ECHO port cannot be opened for both the server and the client, set the check_peer_alive parameter value of the cubrid.conf to none.

The relation of connection between processes is as follows:

application - cub_broker
            -> CAS  -  cub_master
                    -> cub_server

• application: The application process
• cub_broker: The broker server process. It selects CAS to connect with the application.
• CAS: The broker application server process. It relays the application and the cub_server.
• cub_master: The master process. It selects the cub_server to connect with the CAS.
• cub_server: The database server process

The symbols of relation between processes and the meaning are as follows:

• - : Indicates that the connection is made only once for the initial.
• ->, <- : Indicates that the connection is maintained. The right side of -> or the left side of <- is the party that the arrow symbol indicates. The party that the arrow symbol indicates is the listener which listens to the opposite process.
• (master): Indicates the master node in the HA configuration.
• (slave): Indicates the slave node in the HA configuration.

The connection process between the application and the DB is as follows:

1. The application tries to connect to the cub_broker through the broker port (BROKER_PORT) set in the cubrid_broker.conf.

2. The cub_broker selects a connectable CAS.

3. The application and CAS are connected.

   In Linux, BROKER_PORT, which is used as an application, is connected to CAS through the Unix domain socket. In Windows, since the Unix domain socket cannot be used, an application and CAS are connected through a port of which the number is the sum of the corresponding CAS ID and the APPL_SERVER_PORT value set in the cubrid_broker.conf. If the APPL_SERVER_PORT value has not been set, the port value connected to the first CAS is BROKER_PORT + 1.

   For example, if the BROKER_PORT is 33000 and the APPL_SERVER_PORT value has not been set in Windows, the ports used between the application and CAS are as follows:

   • The port used to connect the application to the CAS(1): 33001
   • The port used to connect the application to the CAS(2): 33002
   • The port used to connect the application to the CAS(3): 33003

4. CAS sends a request of connecting with the cub_server to the cub_master through the cubrid_port_id port set in the cubrid.conf.

5. CAS and the cub_server are connected.

   In Linux, you should use the cubrid_port_id port as CAS is connected to the cub_server through the Unix domain socket. In Windows, CAS is connected to the cub_server through a random available port as the Unix domain socket cannot be used. If the DB server is running in Windows, a random available port is used between the broker machine and the DB server machine. In this case, note that the operation may not be successful if a firewall blocks the port for the process between the two machines.

6. After that, CAS keeps connection with the cub_server even if the application is terminated until the CAS restarts.

Ports for CUBRID HA¶

The CUBRID HA is supported in Linux only.

The following table summarizes the ports required for each OS, based on the listening processes. Each port on the listener should be opened.

(*): The machine which has the CAS, CSQL, copylogdb, or applylogdb process

(**): The machine which has the cub_server

As the server process (cub_server) and the client processes (CAS, CSQL, copylogdb, applylogdb, etc.) cross-check if the opposite node is normally running or not by using the ECHO(7) port, you should open the ECHO(7) port if there is a firewall. If the ECHO port cannot be opened for both the server and the client, set the ref:check_peer_alive <check_peer_alive> parameter value of the cubrid.conf to none.

The relation of connection between processes is as follows:

application - cub_broker
            -> CAS  -  cub_master(master) <-> cub_master(slave)
                    -> cub_server(master)     cub_server(slave) <- applylogdb(slave)
                                          <----------------------- copylogdb(slave)

• cub_master(master): the master process on the master node in the CUBRID HA configuration. It checks if the peer node is alive.
• cub_master(slave): the master process on the slave node in the CUBRID HA configuration. It checks if the peer node is alive.
• copylogdb(slave): the process which copies the replication log on the slave node in the CUBRID HA configuration
• applylogdb(slave): the process which applies the replication log on the slave node in the CUBRID HA configuration

For easy understanding for the replication process from the master node to the slave node, the applylogdb and copylogdb on the master node and CAS on the slave node have been omitted.

The symbols of relation between processes and the meaning are as follows:

• - : Indicates that the connection is made only once for the initial.
• ->, <- : Indicates that the connection is maintained. The right side of -> or the left side of <- is the party that the arrow symbol indicates. The party that the arrow symbol indicates is the listener which listens to the opposite process.
• (master): Indicates the master node in the HA configuration.
• (slave): Indicates the slave node in the HA configuration.

The connection process between the application and the DB is identical with Default Ports for CUBRID. This section describes the connection process between the master node and the slave node when the master DB and the slave DB are configured 1:1 by the CUBRID HA.

1. The ha_port_id set in the cubrid_ha.conf is used between the cub_master(master) and the cub_master(slave).
2. The copylogdb(slave) sends a request for connecting with the master DB to the cub_master(master) through the port set in the cubrid_port_id of the cubrid.conf on the slave node. Finally, the copylogdb(slave) is connected with the cub_server(master).
3. The applylogdb(slave) sends a request for connecting with the slave DB to the cub_master(slave) through the port set in the cubrid_port_id of the cubrid.conf on the slave node. Finally, the applylogdb(slave) is connected with the cub_server(slave).

On the master node, the applylogdb and the copylogdb run for the case that the master node is switched to the slave node.

Ports for CUBRID Web Manager and CUBRID Manager Server¶

The following table summarizes the ports, based on the listening processes, used for the CUBRID Web Manager and the CUBRID Manager server. The ports are identical regardless of the OS type.

• The port used when the CUBRID Manager client accesses the CUBRID Manager server process is cm_port of the cm.conf. The default value is 8001.
• The port used when the CUBRID Web Manager client accesses the CUBRID Web Manager server process is also cm_port of the cm.conf.

Cautions during upgrade¶

Behavioral Changes

To see the behavioral changes from 10.0, please see Behavior Changes in the release notes.

Saving the Existing Configuration File

• Save the configuration files in the $CUBRID/conf directory (cubrid.conf, cubrid_broker.conf and cm.conf) and the DB location file (databases.txt) in the $CUBRID_DATABASES directory.

Checking New Reserved Words

• You can check whether reserved words are being used or not by applying the CUBRID 10.0 reserved word detection script, check_reserved.sql, which is distributed through the CUBRID installation package or http://ftp.cubrid.org/CUBRID_Engine/10.0.0/. If the reserved words are being used as identifiers, the identifiers must be modified. See Identifier.

Configuring environment variables of CUBRID_MSG_LANG

• CUBRID_LANG and CUBRID_CHARSET environment variables are no more used, and the language and the charset should be configured during creating DB. CUBRID_MSG_LANG is used when displaying the messages of utilities or errors. If CUBRID_MSG_LANG is not configured, it follows the language and the charset specified when creating DB.

Changing schema

• 9.0 Beta or earlier version user which had used not ISO-8859-1 charset but EUC-KR charset or UTF-8 charset, should change the schema. In the earlier version of 9.0 Beta, the precision of CHAR or VARCHAR was specified as byte size. From 9.0 Beta, the precision is specified as character length.

Adding/Keeping locales

• If you have locales to want to add, add them into $CUBRID/conf/cubrid_locales.txt file and run make_locale script. For more details, see Locale Setting.
• If you want to keep the old version's locale, add the old version's locale to $CUBRID/conf/cubrid_locales.txt file and run make_locale script, and specify the old locale when running createdb command.

DB migration

• Since the DB volume of CUBRID 9.x and earlier versions are not compatible with the DB volume of CUBRID 10.0, it should be migrated with cubrid unloaddb/loaddb utility. For more detail procedure, see DB migration.
• CUBRID 2008 R3.1 and later don't support GLO and the LOB type replaces the GLO feature. For this reason, applications or schemas that use GLO must be modified to be compatible with LOB.

Reconfiguring environments for replication or HA

• From 2008 R4.0, the replication feature is no longer supported; therefore, it is recommended to reconfigure the DB migration and HA environment for systems in which previous replication versions are used. In addition, for systems that use Linux Heartbeat-based HA feature, which is provided in CUBRID 2008 R2.0 and 2008 R2.1, you must reconfigure to DB migration and the CUBRID Heartbeat-based HA environment for better operational stability(see Database Migration under HA Environment).
• To reconfigure the HA environment configuration, see CUBRID HA in the manual.

Java Stored Function/Procedure

• A user who uses Java stored function/procedure should run loadjava command to load Java classes into CUBRID. See Java Stored Function/Procedure.

Upgrading from CUBRID 9.2/9.3 to CUBRID 10.0¶

Users who are using versions CUBRID 9.2/9.3 should install 10.0 in the different directory, migrate the databases to 10.0 and modify parameter values in the previous environment configuration file.

Upgrading from CUBRID 9.1 to CUBRID 10.0¶

Users who are using versions CUBRID 9.1 should install 10.0 in the different directory, migrate databases to 10.0 and modify parameter values in the previous environment configuration file.

Upgrading From CUBRID 2008 R4.1/R4.3/R4.4 To CUBRID 10.0¶

Users who are using a version of CUBRID 2008 R4.1, R4.3 or R4.4 should install 10.0 in the different directory, migrate databases to 10.0 and modify parameter values in the existing environment configuration file.

Upgrading From CUBRID 2008 R4.0 or Earlier Versions To CUBRID 10.0¶

Users who are using versions CUBRID 2008 R4.0 or earlier should install 10.0 in the different directory, migrate databases to 10.0 and modify parameter values in the existing environment configuration file.

HA migration from CUBRID 2008 R2.2 or higher to CUBRID 10.0¶

In the scenario described below, the current service is stopped to perform an upgrade in an environment in which a broker, a master DB and a slave DB are operating on different servers.

HA Migration from CUBRID 2008 R2.0/R2.1 to CUBRID 10.0¶

If you are using the HA feature of CUBRID 2008 R2.0 or 2008 R2.1, you must upgrade the server version, migrate the database, set up a new HA environment, and then change the Linux Heartbeat auto start setting used in 2008 R2.0 or 2008 R2.1. If the Linux Heartbeat package is not needed, delete it.

Perform steps C1~C10 above, then perform step C11 below:

Uninstalling CUBRID in Linux¶

Uninstalling CUBRID of SH package or compressed package

To uninstall SH package(file extension of installing package is .sh) or compressed package(file extension of installing package is .tar.gz), proceed the following steps.

• Remove databases after stopping CUBRID service.

  Remove all created databases after stopping CUBRID service.

  For example, if there are testdb1, testdb2 as databases, do the following commands.

  $ cubrid service stop
  $ cubrid deletedb testdb1
  $ cubrid deletedb testdb2
  

• Remove CUBRID engine.

  Remove $CUBRID and its subdirectories.

  $ echo $CUBRID
      /home1/user1/CUBRID
  
  $ rm -rf /home1/user1/CUBRID
  

• Remove auto-starting script.

  If you stored cubrid script in /etc/init.d directory, remove this file.

  cd /etc/init.d
  rm cubrid
  

Uninstalling CUBRID of RPM package

If you have installed CUBRID in RPM package, you can uninstall CUBRID by "rpm" command.

• Remove databases after stopping CUBRID service.

  Remove all created databases after stopping CUBRID service.

  For example, if there are testdb1, testdb2 as databases, do the following commands.

  $ cubrid service stop
  $ cubrid deletedb testdb1
  $ cubrid deletedb testdb2
  

• Remove CUBRID engine.

  $ rpm -q cubrid
  cubrid-9.2.0.0123-el5.x86_64
  
  $ rpm -e cubrid
  warning: /opt/cubrid/conf/cubrid.conf saved as /opt/cubrid/conf/cubrid.conf.rpmsave
  

• Remove auto-starting script.

  If you stored cubrid script in /etc/init.d directory, remove this file.

  cd /etc/init.d
  rm cubrid
  

Uninstalling CUBRID in Windows¶

Choose "CUBRID" in "Control panel > Uninstall a program" and uninstall it.

Shell Command¶

The following shell command can be used to start the CUBRID service and the demodb included in the installation package.

% cubrid service start

@ cubrid master start
++ cubrid master start: success

@ cubrid broker start
++ cubrid broker start: success

@ cubrid manager server start
++ cubrid manager server start: success

% cubrid server start demodb

@ cubrid server start: demodb

This may take a long time depending on the amount of recovery works to do.

CUBRID 9.2

++ cubrid server start: success

@ cubrid server status

Server demodb (rel 9.2, pid 31322)

CUBRIDService or CUBRID Service Tray¶

On the Windows environment, you can start or stop a service as follows:

• Go to [Control Panel] > [Performance and Maintenance] > [Administrator Tools] > [Services] and select the CUBRIDService to start or stop the service.

  

• In the system tray, right-click the CUBRID Service Tray. To start CUBRID, select [Service Start]; to stop it, select [Service Stop].

  Selecting [Service Start] or [Service Stop] menu would be like executing cubrid service start or cubrid service stop in a command prompt; this command runs or stops the processes configured in service parameters of cubrid.conf.

• If you click [Exit] while CUBRID is running, all the services and process in the server stop.

Creating Databases¶

You can create databases by using the cubrid createdb utility and execute it where database volumes and log volumes are located. If you do not specify additional options such as --db-volume-size or --log-volume-size, 1.5 GB volume files are created by default (generic volume is set to 512 MB, active log is set to 512 MB, and background archive log is set to 512 MB).

% cd testdb
% cubrid createdb testdb en_US
% ls -l

-rw------- 1 cubrid dbms 536870912 Jan 11 15:04 testdb
-rw------- 1 cubrid dbms 536870912 Jan 11 15:04 testdb_lgar_t
-rw------- 1 cubrid dbms 536870912 Jan 11 15:04 testdb_lgat
-rw------- 1 cubrid dbms       176 Jan 11 15:04 testdb_lginf
-rw------- 1 cubrid dbms       183 Jan 11 15:04 testdb_vinf

In the above, testdb represents a generic volume file, testdb_lgar_t represents a background archive log file, testdb_lgat represents an active log file, testdb_lginf represents a log information file, and testdb_vinf represents a volume information file.

For details on volumes, see Database Volume Structure . For details on creating volumes, see createdb. It is recommended to classify and add volumes based on its purpose by using the cubrid addvoldb utility. For details, see addvoldb.

Starting Database¶

You can start a database process by using the cubrid server utility.

% cubrid server start testdb

To have testdb started upon startup of the CUBRID service (cubrid service start), configure testdb in the server parameter of the cubrid.conf file.

% vi cubrid.conf

[service]

service=server,broker,manager
server=testdb

...

CSQL Interpreter¶

The CSQL Interpreter is a program used to execute the SQL statements and retrieve results in a way that CUBRID supports. The entered SQL statements and the results can be stored as a file. For more information, see Introduction to the CSQL Interpreter and CSQL Execution Mode.

CUBRID also provides a GUI-based program called "CUBRID Manager" or "CUBRID Query Browser." By using these tools, you can execute all SQL statements and retrieve results in the query editor of CUBRID Manager. For more information, see Management Tools.

This section describes how to use the CSQL Interpreter on the Linux environment

Starting the CSQL Interpreter

You can start the CSQL program in the shell as shown below. At the initial installation, PUBLIC and DBA users are provided and the passwords of the users not set. If no user is specified while the CSQL Interpreter is executed, PUBLIC is used for log-in.

% csql demodb

CUBRID SQL Interpreter

Type `;help' for help messages.

csql> ;help

=== <Help: Session Command Summary> ===


   All session commands should be prefixed by `;' and only blanks/tabs
   can precede the prefix. Capitalized characters represent the minimum
   abbreviation that you need to enter to execute the specified command.

   ;REAd   [<file-name>]       - read a file into command buffer.
   ;Write  [<file-name>]       - (over)write command buffer into a file.
   ;APpend [<file-name>]       - append command buffer into a file.
   ;PRINT                      - print command buffer.
   ;SHELL                      - invoke shell.
   ;CD                         - change current working directory.
   ;EXit                       - exit program.

   ;CLear                      - clear command buffer.
   ;EDIT                       - invoke system editor with command buffer.
   ;LISt                       - display the content of command buffer.

   ;RUn                        - execute sql in command buffer.
   ;Xrun                       - execute sql in command buffer,
                                 and clear the command buffer.
   ;COmmit                     - commit the current transaction.
   ;ROllback                   - roll back the current transaction.
   ;AUtocommit [ON|OFF]        - enable/disable auto commit mode.
   ;REStart                    - restart database.

   ;SHELL_Cmd  [shell-cmd]     - set default shell, editor, print and pager
   ;EDITOR_Cmd [editor-cmd]      command to new one, or display the current
   ;PRINT_Cmd  [print-cmd]       one, respectively.
   ;PAger_cmd  [pager-cmd]

   ;DATE                       - display the local time, date.
   ;DATAbase                   - display the name of database being accessed.
   ;SChema class-name          - display schema information of a class.
   ;SYntax [sql-cmd-name]      - display syntax of a command.
   ;TRigger [`*'|trigger-name] - display trigger definition.
   ;Get system_parameter       - get the value of a system parameter.
   ;SEt system_parameter=value - set the value of a system parameter.
   ;PLan [simple/detail/off]   - show query execution plan.
   ;Info <command>             - display internal information.
   ;TIme [ON/OFF]              - enable/disable to display the query
                                 execution time.
   ;LINe-output [ON/OFF]       - enable/disable to display each value in a line
   ;HISTORYList                - display list of the executed queries.
   ;HISTORYRead <history_num>  - read entry on the history number into command buffer.
   ;TRAce [ON/OFF] [text/json] - enable/disable sql auto trace.
   ;HElp                       - display this help message.

Running SQL with CSQL

After the CSQL has been executed, you can enter the SQL into the CSQL prompt. Each SQL statement must end with a semicolon (;). Multiple SQL statements can be entered in a single line. You can find the simple usage of the session commands with the ;help command. For more information, see Session Commands.

% csql demodb

csql> SELECT SUM(n) FROM (SELECT gold FROM participant WHERE nation_code='KOR'
csql> UNION ALL SELECT silver FROM participant WHERE nation_code='JPN') AS t(n);

=== <Result of SELECT Command in Line 2> ===

       sum(n)
=============
           82

1 rows selected. (0.106504 sec) Committed.

csql> ;exit

Running SQL with CUBRID Web Manager¶

Because CUBRID 2008 R4.3 or higher version includes Web Manager on the installation package, you can use the Web Manager instantly after the installation of CUBRID DBMS.

1. Configure the value of support_web_manager in cm.conf as "YES".

2. Start CUBRID Service. Web Manager works normally only when CUBRID Manager server is started. For more information, see CUBRID Manager Server.

   C:\CUBRID>cubrid service start
   ++ cubrid service is running.
   

3. Access to https://localhost:8001/ which is written on the address bar. Note that the header of address is not http, but https.

4. First, log-in to the host. To access to the host, you should perform the CUBRID Manager server user (=the host user)'s authentication primarily. The default user ID/password is admin/admin.

   

5. Connect to the DB server. In the tree on the left, you can see the list of databases which have been generated within the corresponding host. Click the DB name that you want to access and perform the DB user authentication (default ID/password: dba/pressing enter key)

   

6. Run the SQL on the access DB and confirm the result. On the left side, the list of connected databases are displayed. You can edit, run, and find the result on the SQL tab.

   

For more information, see http://www.cubrid.org/wiki_tools/entry/cubrid-web-manager-manual.

Running SQL with CUBRID Manager Client¶

CUBRID Manager is the client tool that you should download and run. It is a Java application which requires JRE or JDK 1.6 or higher.

1. Download and install the latest CUBRID Manager file. CUBRID Manager is compatible with CUBRID DB engine 2008 R2.2 or higher version. It is recommended to upgrade to the latest version periodically; it supports the auto-update feature. (CUBRID FTP: http://ftp.cubrid.org/CUBRID_Tools/CUBRID_Manager )

2. Start CUBRID service on the server. CUBRID Manager server should be started for CUBRID Manager client to access to DB. For more information, see CUBRID Manager Server.

   C:\CUBRID>cubrid service start
   ++ cubrid service is running.
   

3. After the installation of CUBRID Manager, register host information on the [File > Add Host] menu. To register the host, you should enter host address, connection port (default: 8001), and CUBRID Manager user name/password and install the JDBC driver of the same version with DB engine (supporting auto-driver-search/auto-update).

4. Choose the host on the left tress and perform the CUBRID Manager user (=host user) authentication. The default ID/password is admin/admin.

5. Create a new database as clicking the right mouse button on the database node, or try to connect as choosing the existing database on the bottom of the host node. At this time, do the DB user's login. The default db user is "dba", and there is no password.

6. Run SQL on the access DB and confirm the result. The host, DB and table list are displayed on the left side, and the query editor and the result window is shown on the right side. You can reuse the SQLs which have been succeeded with [SQL History] tab and compare the multiple results of several DBs as adding the DBs for the comparison of the result with [Multiple Query] tab.

   

For more information, see http://www.cubrid.org/wiki_tools/entry/cubrid-manager-manual_kr.

Running SQL with CUBRID Query Browser¶

CUBRID Query Browser (hereafter CQB) is the development tool only for SQL execution, light-weight version of CUBRID Manager (hereafter CM). The differences with CM are as follows:

• CQB can access DB via JDBC only, without CM server.
• As a result, DB/broker operating and monitoring features are not supported.
• As a result, CQB only logs in DB user and CM user login is unnecessary.
• Running CUBRID Manager server on the server side is unnecessary.

CQB client tool also needs to be downloaded and installed separately from the CUBRID installation package. It is executed on a Java application which requires JRE or JDK 1.6 version or later.

1. Install the latest CQB file after download. It is compatible with any versions of the engine if you just add the same version's JDBC driver with the DB server. It is recommended to upgrade to the latest version periodically because it supports the auto-update feature. (CUBRID ftp: http://ftp.cubrid.org/CUBRID_Tools/CUBRID_Query_Browser )

2. Register DB access information on the [File > New Connection] menu after installing CQB. In this case, broker address, broker access port (default: 33,000), DB user, and password should be entered and the JDBC driver which has the same version with DB server should be installed (supporting auto-driver-search/auto-update).

3. Try to access as choosing DB. In this case, perform DB authentication (default: dba/pressing enter key).

4. Run SQL on the access DB and confirm the result. The lists of Host, DB, and table are displayed on the left side, and the query editor/result window are shown on the right side. You can reuse the SQLs which have been succeeded with [SQL History] tab and compare the multiple results of several DBs as adding the DBs for the comparison of the result with [Multiple Query] tab.

   

For more information, see http://www.cubrid.org/wiki_tools/entry/cubrid-query-browser-manual_kr.

Migrating schema/data with CUBRID Migration Toolkit¶

CUBRID Migration Toolkit is a tool to migrate the data and the schema from the source DB (MySQL, Oracle, and CUBRID) to the target DB (CUBRID). It is also Java applications which require JRE or JDK 1.6 or later. You should download separately. (CUBRID FTP: http://ftp.cubrid.org/CUBRID_Tools/CUBRID_Migration_Toolkit )

It is useful in case of switching from other DB into CUBRID, in case of migrating into other hardware, in case of migrating some schema and data from the operating DB, in case of upgrading CUBRID version, and in case of running the batch jobs. The main features are as follows:

• Supports the tools/some schema and data migration
• Available to migrate only the desired data as running several SQLs
• Executable without suspending of operation as supporting online migration through JDBC
• Available offline migration with CSV, SQL, CUBRID loaddb format data
• Available to run directly on the target server as extracting the run-script of migration
• Shorten the batch job time as reusing the migration run-script.

For more information, see http://www.cubrid.org/wiki_tools/entry/cubrid-migration-toolkit-manual.