Skip Headers
Oracle® TimesTen In-Memory Database Installation Guide
11g Release 2 (11.2.2)

E21632-12
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

1 TimesTen Installation

This chapter contains configuration information that you should review before installing TimesTen on your system, in the sections:

You can find a description of the procedures to install, configure and uninstall TimesTen:

Note:

This document does not discuss TimesTen installation on an Exalytics system. Go to the following location for Exalytics documentation:

http://www.oracle.com/technetwork/documentation/exalytics-doc-1645656.html

This chapter also contains information to help you further configure TimesTen after installation, work with the demo applications, migrate databases to this release, and view the TimesTen documentation:

This chapter contains information that helps you troubleshoot problems that may arise during the installation process and a link to licensing information:

Installation instances

On UNIX, you can install multiple instances of TimesTen, where an instance is essentially the collection of files and processes related to a TimesTen installation. On Windows, you can install only one instance of any major TimesTen release, where a major release is indicated by the first three parts of the release number, such as 11.2.2. For example, you can install both 11.2.1.9.0 and 11.2.2.5.0 on the same Windows computer, but you cannot install both 11.2.2.0.0 and 11.2.2.5.0.

The TimesTen product can be installed onto local, private disk storage, such that each computer has a private copy of the entire TimesTen installation. Installing a single copy of the TimesTen software onto a shared storage location and then sharing this copy among several computers is not a supported configuration.

The following sections provide more information about the TimesTen installation instance:

Instance naming

The instance name is the key used to access all necessary information about an installation of TimesTen.

On UNIX systems, by default, the instance name for this release is tt1122_32 on 32-bit installations and tt1122_64 on 64-bit installations. The instance name is case-insensitive, at least one alphanumeric character and up to 255 characters. The name can include underscores (_) or periods (.), but no other special characters.

To install a second instance of the same TimesTen release on UNIX, you must supply a unique instance name and port number. The TimesTen installer can detect if an instance of the particular release of TimesTen exists on the computer and prompts you for a new instance name and port number for the main TimesTen daemon.

The instance name on Windows is tt1122_32 on 32-bit installations and tt1122_64 on 64-bit installations. Only one instance of any major TimesTen release (such as 11.2.2) can exist on a Windows system.

Instance port numbers

When you install multiple instances of TimesTen on the same computer, specify a unique TCP/IP port number for each TimesTen daemon and each TimesTen server during the installation.

Note:

If you will be using replication, however, be aware that if the daemon ports are not the same for TimesTen databases that replicate to each other, you must use static ports for replication and you must use the ttRepAdmin utility -remoteDaemonPort option for duplicate operations. You can use the ttVersion utility to verify the port number of your installation of TimesTen.

Choosing the appropriate TimesTen components

The TimesTen installer enables you to select the components of TimesTen that you want to install.

Components available on UNIX

On UNIX, you can install the following components. In addition, the installation script prompts you to install the TimesTen Quick Start and documentation.

Type Description
TimesTen Client Installs the TimesTen Client only. No other TimesTen components are installed on the computer. Use this installation to allow the TimesTen Client to access the TimesTen Server from another installation.
TimesTen Data Manager Installs the TimesTen Data Manager only. Use this installation to run the TimesTen Data Manager locally.
TimesTen Client, Server and Data Manager Installs the TimesTen Data Manager, Client, and Server. Use this installation to perform the following:
  • Allow a Client from another installation to access the TimesTen Server.

  • Allow the TimesTen Client to access either this TimesTen Server installation or another TimesTen Server installation.

  • Allow applications to access the TimesTen Data Manager locally.


If you have installed TimesTen and you would like to add or remove components, you must run the installer and select the option "Upgrade an existing instance," and then select the instance which you would like to change.

Components available on Windows

On Windows, you can specify the components to install by selecting or deselecting the appropriate checkboxes during installation. By default, all components are installed except the TimesTen Data Manager Debug Libraries.

Type Description
TimesTen Data Manager Installs the TimesTen Data Manager. Use this installation to run the TimesTen Data Manager locally.
TimesTen Data Manager Debug Libraries Installs the TimesTen Data Manager debug libraries. Used particularly during the development phase to allow you to debug problems that may occur. By default, the debug libraries are not installed.
TimesTen Server Installs the TimesTen Data Server and TimesTen Data Manager.
TimesTen Client Installs the TimesTen Client, which you can use to access the TimesTen Server on a remote computer.

Note: In the Windows 64-bit installer, there are options for the 64-bit client and the 32-bit client. You can install both (default), either, or neither.

TimesTen Quick Start Installs the TimesTen Quick Start, which includes demos.
TimesTen Documentation Installs the TimesTen Documentation Library.

Installation prerequisites

Before installing TimesTen, ensure the appropriate requirements are met for your operating system.

On both UNIX and Windows platforms where JDBC is supported you must have the appropriate version of the JDK installed on your computer to use JDBC.

In addition, be aware that if you use automatic client failover, to accommodate a firewall you must specify a UDP port or port range. (Also see "Configuring automatic client failover" in Oracle TimesTen In-Memory Database Operations Guide.)

Important:

Do not install TimesTen as an OS user whose name matches any of the TimesTen predefined internal users: GRID, PUBLIC, SYS, SYSTEM, or TTREP. If you install TimesTen as a user with one of these names, attempts to create a database fail with a unique constraint violation error.

This section also discusses the platform-specific prerequisites:

General UNIX requirements

In general, on UNIX systems, you must configure the following:

  • The number of semaphores

  • Allowable shared memory

In addition, you may need to perform the following:

  • Ensure you have the latest operating system patches.

  • Configure your file system to allow large files.

  • Configure your Java environment.

  • Configure your Client/Server environment.

  • Configure network settings for replication.

The following sections outline some changes that may be required on any UNIX system. In addition, some of these sections describe changes required for each specific UNIX platform on which TimesTen is supported.

Veritas file system options

On the Veritas file system, if you plan to have TimesTen applications that use DurableCommits=1, use the mincache=direct and convosync=direct options to ensure durability.

Options that convert dsync into sync or fdatasync into sync or those that treat all writes such that the file is opened with O_SYNC should be avoided.

On the Veritas file system you should also set the options discovered_direct_iosz and max_direct_iosz to 3 MB.

The absence of these direct I/O settings could result in poor file system performance for TimesTen operations.

To set these options, log in as root and use:

# /usr/sbin/vxtunefs -o discovered_direct_iosz=3145728
# /usr/sbin/vxtunefs -o max_direct_iosz=3145728

Semaphores (general UNIX)

TimesTen uses one semaphore set per active database, plus one semaphore set per TimesTen instance where Client/Server is used with shared memory.

Each active database uses a total of 155 semaphores. Semaphore usage for each TimesTen instance using Client/Server with shared memory corresponds to the number of connections, with the maximum number of semaphores being a number somewhat larger than the maximum number of connections (to allow for TimesTen internal connections).

For platform-specific semaphore information, see "Semaphores (Linux)" and "Create a project (Solaris)". In AIX, semaphores are configured dynamically by the kernel.

For related information about the TimesTen Connections attribute, which specifies the maximum number of concurrent database connections, see "Connections" in Oracle TimesTen In-Memory Database Reference.

Java

If you are running JDBC, install the latest JDK and any vendor required patches. Refer to the website of the JDK provider for the patches you may need.

To run 64-bit Java applications on all systems except AIX systems, if you are using the 64-bit JVM, you may need to pass the -d64 option on the java command line.

AIX prerequisites

On AIX, before installation, set the kernel parameter sb_max to a minimum of 512 KB if you plan to use replication. The replication agent requests TCP send and receive buffers of a minimum size of 512 KB. The value may be changed using the following command.

# /usr/sbin/no -p -o sb_max=524288

To query the value, use the following command:

# /usr/sbin/no -o sb_max

Large pages (AIX)

On AIX systems with the required patch levels, TimesTen can use large pages. Using large pages locks the shared segment into memory so it cannot be paged. Users must have the CAP_BYPASS_RAC_VMM and CAP_PROPAGATE capabilities. The capabilities are granted by a root user by editing the /etc/security/user file or for locally authenticated users with:

# chuser capabilities=CAP_BYPASS_RAC_VMM,CAP_PROPAGATE user_id

The system default is to not have any memory allocated to the large page physical memory pool. You can use the vmo command to configure the size of the large page physical memory pool. The following example allocates 4 GB to the large page physical memory pool.

# vmo -r -o lgpg_regions=256 -o lgpg_size=16777216

To use large pages for shared memory, you must enable the SHM_PIN shmget() system call with the following command, which persists across system restarts:

# vmo -p -o v_pinshm=1 

Linux prerequisites

For Linux, TimesTen has been tested with releases of Oracle Linux, Asianux, Red Hat Enterprise Linux, the MontaVista Linux Carrier Grade Edition, and SuSE LINUX Enterprise Server. Consult Oracle TimesTen In-Memory Database Release Notes for details about supported releases.

Important:

Because Oracle Database does not support MontaVista Linux Carrier Grade Edition, there are significant restrictions to TimesTen functionality on that platform. See the release notes for details.

On Linux, before installation, the following sections describe steps you can perform to improve the performance of TimesTen on your system:

Large pages (Linux)

Large pages, also referred to as "huge pages" in Linux, can be enabled only if the running Linux kernel supports them. If huge pages are supported, there should be special files in the /proc directory that indicate the settings.

The root user can configure huge pages by setting the vm.nr_hugepages value in the /etc/sysctl.conf file. (Setting /proc/sys/vm/nr_hugepages is equivalent, but not persistent and therefore not recommended.) The vm.hugetlb_shm_group value must also be set to the group ID of the user that is running the main TimesTen daemon.

Consider an example where the TimesTen database is 100 GB (102,400 MB) and the huge page size is 2 MB. Set the number of huge pages to at least 51,200:

vm.nr_hugepages = 51200
vm.hugetlb_shm_group = "id -g mygroup"

When you are done editing sysctl.conf, execute the command "sysctl -p". This will make the changes dynamically and immediately (otherwise, edits to sysctl.conf do not take effect until the system is rebooted).

Use the following command to see system memory information, including the number and size of the allocated huge pages:

% cat /proc/meminfo

The preceding example would result in the following values in meminfo (2048 KB being equivalent to 2 MB):

HugePages_Total: 51200
HugePages_Free: 51200
Hugepagesize: 2048 kB

The operating system now is ready for huge page support. To enable this feature on TimesTen, set -linuxLargePageAlignment Size_in_MB in the daemon options file, ttendaemon.options. This would be 2 in the preceding example.

When TimesTen uses huge pages, the HugePages_Free value in /proc/meminfo changes accordingly.

Notes:

  • Because huge pages must be allocated in contiguous available memory space, the requested allocation may not be granted, or may be only partially granted, until after reboot. Check values from meminfo as shown above to confirm the allocation. Rebooting will grant you the full allocation, assuming enough memory is available in the system.

  • If a TimesTen database smaller than 256 GB does not fit into the available huge pages space, regular pages will be used instead. If a database greater than or equal to 256 GB does not fit, there will be an error, because databases that large require huge pages.

  • The PL/SQL memory segment generally uses huge pages, if there are enough available, due to its relatively small size. This is regardless of whether the database uses huge pages.

  • The huge page size is not configurable. It is fixed for each platform.

  • If PAM (Pluggable Authentication Modules) is enabled, you may need to modify the /etc/security/limits.conf file to increase the memlock limit. By default, the limit is 32 KB.

Required library packages

For TimesTen to work properly on MontaVista Linux, include the libaio and libelf library packages.

Semaphores (Linux)

Also see "Semaphores (general UNIX)".

On Linux, you can use the following formula as a guide for semaphores, although in practice, SEMMNS can be much less than SEMMNI * SEMMSL.

SEMMNS = (SEMMNI * SEMMSL)

To view existing kernel parameter settings, log in as root and use:

# /sbin/sysctl -a

On Linux systems, the first parameter of kernel.sem must be a minimum of 128. TimesTen uses 155 SEMMSL, plus one for each active connection. You must increase the kernel parameter settings if you plan to use a large number of connections.

For example, if you plan to use 200 connections, specify a kernel.sem setting such as the following in the /etc/sysctl.conf file:

kernel.sem = 270 32000 100 128

The first parameter, the maximum number of semaphores per array (SEMMSL), is the most significant for this discussion. This value is related to the maximum number of connections, with some allowance for TimesTen internal connections. The second parameter is maximum semaphores systemwide (SEMMNS), the third parameter is maximum operations per semop call (SEMOPM), and the fourth parameter is maximum arrays (SEMNI).

Then restart the system or run the following command:

# /sbin/sysctl -p

Notes:

  • The kernel.sem setting is also relevant for TimesTen Client/Server connection, discussed in "IPC Client/Server".

  • SEMMSL allocations are based on powers of 2. To be efficient, use a setting somewhat larger than the nearest power of 2.

Shared memory

To increase the shared memory size to 2048 MB, log in as root and edit the /etc/sysctl.conf file by adding the following line, where shmmax is the maximum size of any shared memory segment:

kernel.shmmax=2147483648

You should also increase the value of shmall, the total number of shared memory pages system-wide. The value is in KB and should be equal to ceil(SHMMAX/PAGE_SIZE). Page size is generally 4 KB on x86 systems and 16 KB on Itanium. For example, for a 64 GB database on Itanium, specify the following parameters values:

kernel.shmmax=68719476736
kernel.shmall=4194304

To increase the shared memory size without restarting:

% /sbin/sysctl -w kernel.shmmax=2147483648

If you have your kernel configured with the /proc file system and it is mounted, then the current maximum shared memory segment size (in bytes) can be viewed by the following command:

% cat /proc/sys/kernel/shmmax

You can also change this value by the following command:

% echo 2147483648 > /proc/sys/kernel/shmmax

This command has the same effect as the sysctl command.

IPC Client/Server

On Linux systems, to enable a given number of ShmIpc Client/Server connections, you must have an appropriate SEMMSL value in the kernel.sem setting in the /etc/sysctl.conf file. For details, see "Semaphores (Linux)".

Then restart the system or run the following command.

# /sbin/sysctl -p

Replication

For replication, TCP send and receive buffers should be increased to a minimum of 512 KB. To increase the buffers to 4 MB, add the following lines to the /etc/sysctl.conf file:

net.ipv4.tcp_rmem=4096 4194304 4194304
net.ipv4.tcp_wmem=98304 4194304 4194304
net.core.rmem_default=65535
net.core.wmem_default=65535
net.core.rmem_max=4194304
net.core.wmem_max=4194304
net.ipv4.tcp_window_scaling=1

Then restart or run this command:

# /sbin/sysctl -p

IMDB Cache

For IMDB Cache, TCP send and receive buffers should be increased to even greater values. To make these changes, add the following lines to the /etc/sysctl.conf file:

net.ipv4.tcp_rmem=4096 4194304 4194304
net.ipv4.tcp_wmem=98304 4194304 4194304
net.core.rmem_default=262144
net.core.wmem_default=262144
net.core.rmem_max=4194304
net.core.wmem_max=4194304
net.ipv4.tcp_window_scaling=1

Then restart or run this command:

# /sbin/sysctl -p

Solaris prerequisites

On Solaris, before installation, the following sections enable you to improve the performance of TimesTen on your system.

File system options

In addition to the file system options listed in the section "General UNIX requirements", on Solaris UFS file systems, if you plan to have TimesTen applications that use DurableCommits=1, mount the file system with the -forcedirectio option.

Create a project (Solaris)

For Solaris 10 and 11 systems, you must create a project to manage system resources, such as shared memory, file descriptors and semaphores. For semaphores, also see "Semaphores (general UNIX)".

You can create a group project or a user project.

Note:

If you create a users group, the instance administrator must run the newtask command each time the TimesTen daemons must be restarted. If the TimesTen daemons start at system start time, add the newtask command to the system startup scripts.

For example, to create a project timesten for the group g500, with 500 GB of shared memory, 4096 semaphores and 65,535 file descriptors:

  1. Login as user root.

  2. Add the group project.

    # projadd -G g500 timesten
    
  3. Modify the shared memory for the group to 500 GB.

    # projmod -a -K "project.max-shm-memory=(priv,500GB,deny)" timesten
    
  4. Modify the maximum number of semaphores to 4096.

    # projmod -a -K "process.max-sem-nsems=(priv,4096,deny)" timesten
    

    Note:

    For each active database, TimesTen consumes 155 SEMMSL, plus one SEMMSL for each connection.
  5. Modify the maximum number of file descriptors to 65,535.

    # projmod -a -K "process.max-file-descriptor=(priv,65535,deny)" timesten
    
  6. Run the newtask command before restarting the TimesTen daemons.

    # newtask -p timesten -c $$
    

Or, for example, to create a user project for the user timesten, with 500 GB of shared memory, 4096 semaphores and 65,535 file descriptors:

  1. Login as user root.

  2. Add the user project.

    # projadd -U timesten user.timesten
    
  3. Modify the shared memory for the group to 500 GB.

    # projmod -a -K "project.max-shm-memory=(priv,500GB,deny)" user.timesten
    
  4. Modify the maximum number of semaphores to 4096.

    # projmod -a -K "process.max-sem-nsems=(priv,4096,deny)" user.timesten
    

    Note:

    For each active database, TimesTen consumes 155 SEMMSL, plus one SEMMSL for each connection.
  5. Modify the maximum number of file descriptors to 65,535.

    # projmod -a -K "process.max-file-descriptor=(priv,65535,deny)" user.timesten
    

Every user and every group are associated to a default project, which is the project under which their processes are run. The project or process settings used by a user are those that occur first in the /etc/project file. If you have not modified the project file, the system default project settings occur first.

Note:

Do not remove the default project settings from the project file. Instead, place your project settings at the top of the project file above the default settings.

For either the user project method or group project method, you have the following options for associating your project settings with the specified user or group.

  • Edit the /etc/project file to move the timesten project entry so that it precedes the default entry.

    Or:

  • Execute the following before restarting daemons. This is required if the project was created with -G only.

    # newtask -p timesten -c $$
    

Windows requirements

The TimesTen debug libraries depend on Visual Studio 2005, 2008, or 2010. If you intend to use the debug libraries, ensure that one of these versions is installed.

On more recent Windows versions, such as Vista, Windows 2008, and Windows 7, you must have Administrator privileges to perform certain operations, such as starting and stopping the TimesTen daemon.

To start a command prompt window with Windows Administrator privileges, you can right-click the cmd.exe executable. (In Windows 7, for example, this executable is located in the C:\Windows\System32 folder.)

When the command window opens, it indicates "Administrator" in the title bar.

Default installation directories

The TimesTen default installation directories for release 11.2.2 are as follows:

The temporary directory is operating system-dependent. Usually it is located according to the following.

You can change the location of your temporary directory by setting the TMP environment variable on Windows. On UNIX, you can change the location of your temporary directory by setting the TMPDIR environment variable.

Note:

TimesTen does not support file path names that contain multibyte characters. Ensure that the installation path, database path, transaction log path, and temporary file path do not contain any multibyte characters. On Windows, the complete temporary directory path must be less than 190 characters for the installation to complete successfully.

Considerations for locations of database files and other user files

During installation, if you have elected to install the TimesTen Quick Start, the installer prompts you for a location for the DemoDataStore directory. On UNIX systems, by default, this is located under the info directory that is under the TimesTen installation path. It is strongly recommended that you choose an alternate location, outside of the TimesTen installation path, for this directory. (On Windows systems, the default location is under the user's application data folder.)

It is also strongly advised that you not store any database files (checkpoint and log files) or any other user files anywhere under the TimesTen installation path. Any files under the installation path, including files not installed by TimesTen, may be removed during upgrade or uninstallation operations.

Pre-Install requirements for operating system group and file permissions

The following sections describe creating the operating system groups and setting the correct directory permissions for TimesTen:

TimesTen instance administrators and users groups

For security, access to the TimesTen installation is restricted to members of a single operating system group, under which TimesTen is installed. This group is referred to as the TimesTen users group. Only users that are members of the TimesTen users group are allowed to perform direct driver connections to TimesTen and perform operations on TimesTen databases. Any users connecting to a TimesTen database through a client connection are not required to be members of the TimesTen users group.

The user that installs TimesTen is the instance administrator. The instance administrator must be a member of the TimesTen instance administrators group, and must also be a member of the TimesTen users group.

  • On Windows, which does not have the same concept of "instance administrators group" as UNIX, the TimesTen users group is effectively equivalent. Therefore, the instance administrator on a Windows installation must be a member of the TimesTen users group to install TimesTen. In addition, all users who perform a direct driver connection must be a member of the TimesTen users group.

  • On UNIX, the TimesTen instance administrators group and the TimesTen users group can be the same or different operating system groups, as follows.

    • TimesTen instance administrators group. Any user installing TimesTen must be a member of this group. This group must be granted read and write access to /etc/TimesTen, which contains information about all TimesTen instances installed on the computer.

    • TimesTen users group. The instance administrator must also be a member of this group to install TimesTen. After installation, only members of this operating system group are allowed to make direct driver connections to TimesTen and perform operations on TimesTen databases.

    The details on how to create both operating system groups on UNIX are included in "Creating UNIX TimesTen instance administrators and users groups".

Directory and file permissions

When installed, read and write permissions on TimesTen files and directories is limited to members of the TimesTen users group, unless TimesTen was installed as "world accessible".

The following sections describe directory and file permissions for Windows and UNIX systems.

Permissions and instance registry prerequisites for TimesTen

On Windows, TimesTen files and directories are accessible only to members of the TimesTen users group.

If you choose to install TimesTen as world accessible, which is an option during the installation, TimesTen files and directories are accessible to everyone. In this case, anyone can perform any action on the TimesTen database files and shared memory segments. This is not recommended. Enable this option only if all users on this computer are trusted and you want to disable all operating system-level access control for this installation.

For more information on operating system groups, see "TimesTen instance administrators and users groups".

On Windows, information about TimesTen is contained in the operating system registry.

On UNIX, TimesTen maintains a registry of all TimesTen instances installed on a given computer in /etc/TimesTen. The instance registry itself is not required for operation, but it is essential for correct installation and uninstallation of TimesTen. Before installing TimesTen, ensure that the user installing TimesTen is a member of the instance administrators group and has read and write permissions on the /etc/TimesTen directory.

The details on how to set the directory permissions for /etc/TimesTen to the instance administrators group are included in the next section, "Creating UNIX TimesTen instance administrators and users groups".

Note:

Checkpoint files and log files for databases should be installed on separate devices. TimesTen writes a message to the support log (formerly the daemon log) if the transaction log files and checkpoint files are on the same file system.

Creating UNIX TimesTen instance administrators and users groups

The following details the pre-installation procedures to create the required operating system groups and set the directory permissions for the UNIX TimesTen installation.

Create the TimesTen users group

During installation, you must specify the TimesTen users group. By default, the TimesTen users group for the instance is the primary operating system group of the user installing TimesTen. If you want the TimesTen users group to be other than the installer primary group, you must specify the name of the group during installation.

Alternatively, you can make the TimesTen instance world accessible. However, this is not recommended.

The only way to change the TimesTen users group is to uninstall and reinstall the TimesTen instance, providing the new group name during reinstallation.

If you do not have an operating system group for TimesTen users, the following outlines certain procedures that must be performed once as user root before installing TimesTen to create the TimesTen users group.

  1. Create an operating system group under which the TimesTen instance can be installed. The name timesten is suggested for this operating system group, but you can choose any name that you prefer.

    Note:

    Throughout this manual, for our examples, timesten is used to represent the name of the TimesTen users group.
  2. Add the user who is installing and any users who are using TimesTen to the TimesTen users group that you just created.

  3. Provide the name of this group, if different from the default TimesTen users group, during the installation at the appropriate time.

The directory and file permissions for the TimesTen installation have the group specified as the group you defined during the installation. This sets the permissions to restrict read and write access for most directories, files, checkpoint files, transaction log files, shared memory segments, and semaphores to this defined group. There are exceptions for certain resources as determined by TimesTen. See "Directory and file permissions" for more information on permissions.

Note:

On Solaris systems, you must be installed as root to use MemoryLock with a setting of 1 or 2. Databases in a non-root instance of TimesTen can use settings 3 and 4 for this attribute on Solaris systems.

Create the TimesTen instance registry and instance administrators group

On UNIX platforms, the instance registry is located in the directory /etc/TimesTen. Initial creation of the /etc/TimesTen directory may require root access. Creation of this directory is a once per computer, pre-installation step.

If the user installing TimesTen does not have read and write access to the /etc/TimesTen directory, the following outlines certain procedures that must be performed once as user root before installing TimesTen.

  1. Create an operating system group for the TimesTen instance administrators group. You can name this group as desired, but examples will use the name ttadmin. For example, on Linux or Solaris:

    # groupadd ttadmin
    
  2. If the directory /etc/TimesTen does not exist, create it.

    # mkdir /etc/TimesTen
    

    The disk space required for the files in this directory is at least 100 KB.

  3. Assign ownership and permissions on the /etc/TimesTen directory to the TimesTen instance administrators group so that only the instance administrator may access and execute. At installation time, the instance_info file is added to the /etc/TimesTen directory. This file must be readable and writable by the instance administrators group.

    Before installing TimesTen, set the permission mode for /etc/TimesTen to 770, and permissions for all files under /etc/TimesTen to 660.

    The following commands modify the group ownership of the TimesTen directory to be the ttadmin group and changes the permissions for all files in this directory to read and write for members of the ttadmin group:

    # chgrp -R ttadmin /etc/TimesTen
    # chmod 770 /etc/TimesTen/
    # chmod 660 /etc/TimesTen/*
    
  4. You can now install TimesTen on UNIX systems. The installer verifies the existence and permissions of /etc/TimesTen and fails if the permissions are not correct.

Installing TimesTen on UNIX systems

The instance may be installed in any directory to which the TimesTen instance administrator has sufficient permission.

Note:

Before beginning installation, ensure that the prerequisites defined in "Installation prerequisites" have been met.

The following sections provide instructions on installing TimesTen on UNIX systems.

Installing TimesTen

To install TimesTen on your UNIX system, use the following steps.

  1. Download the appropriate TimesTen ZIP/TAR file for the current release. File names indicate the platform and release number.

  2. Log in as the TimesTen instance administrator.

  3. Extract the contents of the file.

  4. Change to the platform directory:

    % cd platform
    

    For example on a Linux system:

    % cd linux8664
    
  5. Run the TimesTen setup script:

    % ./setup.sh
    

    Note:

    If a user installs TimesTen as root, the installer gives the following warning: "You are about to install TimesTen as root. TimesTen daemon processes run with root privileges."

    If you click OK to install as root, then the instance administrator is root, and any actions or applications that must be performed by the instance administrator must be run as root.

    While no options are required to install TimesTen, the setup.sh script takes these options:

    Option Description
    -install Installs TimesTen (enabled by default).
    -uninstall Uninstalls TimesTen.

    Also see "Uninstalling TimesTen on UNIX systems".

    -batch filename Allows installation or uninstallation without prompts. The batch file filename is optional.

    If filename is specified, the installation reads all installation prompts from the file.

    If filename is not specified or does not contain an instance name, TimesTen installs a default instance, using tt1122_bits (_32 or _64) for the instance name. If an instance with the same name exists on the installation computer, the installation procedure fails.

    It is recommended that you create the batch file and specifically indicate the instance name of the installation.

    -help Displays the help message.
    -installDoc Installs the TimesTen documentation. (You can do a documentation-only installation.)
    -quickstart Installs the TimesTen Quick Start (to an existing installation).
    -record filename Records responses to the installation questions into the file specified by filename. The file can then be used as the parameter to the -batch option.
    -verbose Displays extra installation information.

  6. Enter your response to the setup script prompts.

Note:

To install or uninstall TimesTen without having to respond to prompts, use the -batch flag with the setup.sh script.

It is recommended that you re-create the response file using -record each time changes are made. Because answers to new installation questions may not be present in the original silent installation response file, unexpected results can occur.

The setup script performs the following actions (unless your answers resulted in termination of the installation process).

  • Prompts you to choose one of the following:

    • Install a new instance.

    • Upgrade an existing instance (in-place upgrade). You can use this option to upgrade to a new patch release within the same major release, such as from 11.2.2.4.0 to 11.2.2.5.0. (See "In-place upgrades".)

      Important: Before upgrading, ensure that you do not have any databases or important files under the TimesTen installation directory. See "Considerations for locations of database files and other user files" for related information.

    • Display information about an existing instance.

    • Quit the installation.

  • Prompts you to choose the default instance name or choose an instance name for your TimesTen instance.

    Note:

    Each TimesTen installation is identified by a unique instance name. The instance name must be a non-null alphanumeric string of 255 characters or less.
  • Prompts you to install one of the following components:

    • Client/Server and Data Manager

    • Data Manager only

    • Client only

  • Prompts you for the location of your TimesTen instance. By default, installs the instance in a subdirectory under $HOME/TimesTen. The subdirectory is named according to the TimesTen instance name. TimesTen documentation refers to this installation directory as install_dir.

  • Prompts you for the location of the TimesTen daemon home directory.

  • Prompts you for the location of TimesTen daemon log files. Note that in this release, separate support and error logs replace the daemon log. The default location is install_dir/info.

  • Prompts you to specify the daemon port number. (The default port number is shown.)

    Notes:

    • When you install multiple instances of TimesTen on the same computer, specify a unique TCP/IP port number for each TimesTen daemon and each TimesTen server during the installation.

    • If you will be using replication, however, be aware that if the daemon ports are not the same for TimesTen databases that replicate to each other, you must use static ports for replication and you must use the ttRepAdmin utility -remoteDaemonPort option for duplicate operations. You can use the ttVersion utility to verify the port number of your installation of TimesTen.

  • Prompts you to set the TimesTen users group or choose world accessibility. For more information on these options, see "Pre-Install requirements for operating system group and file permissions" for details on the TimesTen users group and file permissions. You can do the following:

    1. Restrict access to group default group.

    2. Restrict access to a different group.

    3. Make the TimesTen instance world accessible (not recommended). Choose this option only if all users on this computer are trusted and you want to disable all operating system-level access control for this installation.

  • Prompts you to confirm whether PL/SQL should be installed for the instance. The default answer is "yes". If you choose not to install PL/SQL, you can use the TimesTen ttmodinstall utility to install it later. For more information, see "ttmodinstall" in Oracle TimesTen In-Memory Database Reference.

    Note:

    Installing PL/SQL is encouraged, although it increases the size of some TimesTen libraries. Some features and functionality depend on it.
  • Prompts you to set the TNS_ADMIN environment variable. The value is a directory location where the tnsnames.ora file can be found.

    You can skip this. If you do not specify the location at installation time, you can set it later with the ttmodinstall utility. However, you must specify it before using the In-Memory Database Cache.

  • Prompts you to specify the server port number. (The default port number is shown.)

  • Prompts you to install Quick Start and the TimesTen documentation. The TimesTen Quick Start applications can take up to 64 MB of disk space. The default directory is install_dir/quickstart and install_dir/doc.

  • Prompts for a location for the demo databases. When you install the Quick Start, this is where the TimesTen demo database files are installed. The default location is the install_dir/info/DemoDataStore directory. See the section "Considerations for locations of database files and other user files" for recommendations on choosing an alternative location.

  • Prompts you to indicate whether you want to install TimesTen replication with Oracle Clusterware. Prompts you for the path into which to install the Oracle Clusterware installation on this computer and the port number for the TimesTen Clusterware agent.

    Be aware that TimesTen 11.2.2 supports Clusterware versions 11.2.0.2 and 11.2.0.3 only. (TimesTen 11.2.1 supports Clusterware versions 11.1.0.7, 11.2.0.2, and 11.2.0.3.)

  • The installer checks for any nodes where Oracle Clusterware is currently configured and prompts you to specify a node list for TimesTen replication with Oracle Clusterware. (Note that Oracle Clusterware can be installed or configured after your TimesTen installation, using the ttmodinstall utility.)

  • Removes any previous installation of this release of TimesTen if you are installing an upgrade.

  • Installs the TimesTen components into the appropriate directories.

  • Starts the daemon. (See "Starting and stopping the TimesTen daemon" in Oracle TimesTen In-Memory Database Operations Guide for related information.)

Informational messages on UNIX systems

As the TimesTen daemon operates, it generates error, warning, informational and debug messages for TimesTen system administration and for debugging applications. At installation time, you determine whether these messages go into a file, which is typical, or to the syslog facility. Using the syslog facility is discouraged, but you can refer to your operating system documentation if you are interested in doing so.

If messages are logged using the syslog, the LOG_USER syslog facility is used by default.

To specify the syslog facility used to log TimesTen Daemon and subdaemon messages, on a separate line of the ttendaemon.options file add:

-facility name

Possible name values are: auth, cron, daemon, local0-local7, lpr, mail, news, user, or uucp.

Changing the daemon port number on UNIX

Though the instance registry enforces TCP/IP port uniqueness for TimesTen instances, the possibility of the TimesTen main daemon port conflicting with ports used by non-TimesTen applications always exists.

The ttmodinstall utility allows the instance administrator to change the port number on which the main TimesTen daemon listens. If you have not stopped the TimesTen daemon before using ttmodinstall, the utility stops the daemon before changing the port number. After the port change, the daemon is automatically restarted. This feature is useful if you install TimesTen and later find that the port is in use.

The utility is run from the command line and takes the -port option with the new port number as an argument. For example:

% ttmodinstall -port 12345

See the Oracle TimesTen In-Memory Database Reference for more details on ttmodinstall.

Uninstalling TimesTen on UNIX systems

To uninstall all TimesTen components, follow these steps:

  1. Log in as the TimesTen instance administrator.

  2. The TimesTen setup script is in the install_dir/bin directory. Run the script with the -uninstall option in a directory outside of the installation directory, by typing:

    % install_dir/bin/setup.sh -uninstall
    

Uninstalling removes all TimesTen libraries and executables and also stops and uninstalls the daemon and Server. You can execute ps to verify that all TimesTen processes have terminated. To verify that TimesTen has been successfully uninstalled, verify that the install_dir no longer exists.

Important:

Before uninstalling, ensure that you do not have any databases or important files under the TimesTen installation directory. See "Considerations for locations of database files and other user files" for related information.

Installing TimesTen on Windows systems

This section discusses installation and related issues for Windows systems. Before beginning installation, ensure that the conditions defined in "Installation prerequisites" have been met.

Be aware of the following operational notes:

The following sections provide instructions on installing TimesTen on Windows systems.

Installing TimesTen

To install TimesTen on your Windows system, follow these steps:

  1. Download the appropriate TimesTen ZIP file for the current release. File names indicate the platform and release number.

  2. Extract the contents of the file.

  3. Run the setup.exe executable, which is located in the Win64 or Win32 directory from the ZIP file.

Notes:

  • In Windows 7, you must right-click setup.exe and select "Run as administrator" from the resulting dropdown list. (In earlier Windows versions, you have the necessary administrative privileges by default when you execute setup.exe.)

  • Each time you execute setup.exe, the installer checks for previous TimesTen installations. On Windows, you can install only one instance of any major TimesTen release, where a major release is indicated by the first three parts of the release number, such as 11.2.2. If a previous version of the same TimesTen major release exists (such as 11.2.2.4.0 if you are trying to install 11.2.2.5.0), the installer returns an error message asking you to uninstall the previous release.

The TimesTen installer performs the following actions.

  • Prompts you for the location of the installation. By default, TimesTen is installed in a subdirectory under C:\TimesTen. The subdirectory is named according to the TimesTen instance name, such as C:\TimesTen\tt1122_32 (32-bit installation) or tt1122_64 (64-bit installation). TimesTen documentation refers to this installation directory as install_dir.

  • Prompts you to select the components that you would like to install:

    • TimesTen Data Manager

    • TimesTen Data Manager Debug Libraries

    • TimesTen Server

    • TimesTen Client

      In the 64-bit installation, there are options for both a 64-bit client and a 32-bit client. You can choose both (default), either, or neither. If you install the 32-bit client, it is installed in the tt1122_64\client32 directory.

    • Optional Components

      • TimesTen Quick Start

      • TimesTen Documentation

    For more information, see "Components available on Windows".

  • Prompts for the location to install the demo databases. When you install the TimesTen Quick Start, the demo database files are installed in the DemoDataStore directory that defaults to the following location:

    %APPDATA%\TimesTen\DemoDataStore\
    

    This is a location such as the following, for example:

    C:\Documents and Settings\username\Application Data\TimesTen\DemoDataStore\
    

    Or the equivalent on Window 7, where C:\Users replaces C:\Documents and Settings. For example:

    C:\Users\username\Application Data\TimesTen\DemoDataStore\
    

    Note that Application Data may be a symbolic link (to AppData\Roaming on Windows 7, for example). See the section "Considerations for locations of database files and other user files" for suggestions on selecting a location for the demo database files.

  • Prompts you to set the TNS_ADMIN environment variable. The value is a directory location where the tnsnames.ora file can be found.

    You can leave this field blank. If you do not specify the location at installation time, you can set it later with the ttmodinstall utility. However, you must specify it before using the In-Memory Database Cache.

  • Prompts you to select the Program Folder. Browse to choose the folder that you want for this installation either from existing folders or a new folder. The default is TimesTen 11.2.2 (32-bit) or TimesTen 11.2.2 (64-bit).

  • Asks if you want permissions on this installation to be readable and writable by anyone who has access to the computer. This is not recommended. If disabled, permissions are restricted to users who are members of the TimesTen users group. See "Pre-Install requirements for operating system group and file permissions" for details on permissions and world accessibility. Choose this option only if you want to disable all operating system-level access control for this installation.

  • Prompts you to confirm whether PL/SQL should be installed for the instance. The default answer is "yes". If you choose not to install PL/SQL, you can use the TimesTen ttmodinstall utility to install it later. For more information, see "ttmodinstall" in Oracle TimesTen In-Memory Database Reference.

    Note:

    Installing PL/SQL is encouraged, although it increases the size of some TimesTen libraries. Some features and functionality depend on it.
  • Prompts you to register environment variables. If selected, the installation program adds TimesTen directories to the system environment variables PATH, LIB, and INCLUDE and sets other appropriate variables. If you decide not to register the environment variables at installation time, you can set the environment variables at any time after installation on a per session basis by running the batch file install_dir\bin\ttenv.bat. See "Setting environment variables for TimesTen" for information about ttenv.

    Note:

    This is not advisable if you are installing multiple versions of TimesTen, in which case the path could cause unexpected behavior. (Multiple versions can only be multiple major releases. Multiple patch releases within the same major release are not allowed on Windows.)
  • Prompts you to select the JDK version, if any, to add to the CLASSPATH variable.

  • Displays your installation selections before continuing to install TimesTen.

  • Prompts you to display the release notes and launch the Quick Start Guide. For information on the Quick Start, see "TimesTen Quick Start".


Note:

TimesTen cannot be installed in a mapped network drive. Attempting to do so results in an error.

Installing TimesTen in silent mode

TimesTen enables you to save installation options to a batch file, referred to as a response file, that you can later use to install TimesTen without having to answer each option in a dialog box.

  • To create a response file in the default location, use the following command:

    C:> setup.exe /r
    

    With this command, TimesTen walks you through a normal setup operation and, by default, saves your responses to the file C:\Windows\setup.iss.

  • To later do a silent installation using the options saved to the default response file, use the following command:

    C:> setup.exe /s
    

    This acquires the installation options from the response file. No dialog boxes appear. (Some information pop-up dialogs may still appear, however, such as the one that informs you that the services are being started.)

Alternatively, you can use the f1 option to specify the name and location of the response file.

  • To create the response file mysetup.iss in C:\Temp, use the following command:

    C:> setup.exe /r /f1"C:\Temp\mysetup.iss"
    
  • To use this response file for a silent installation, use the following command.

    C:> setup.exe /s /f1"C:\Temp\mysetup.iss"
    

Note:

Batch files from releases older than TimesTen Release 11.2.2 should not be used to install this release. All new prompts in the installer for this release are assigned default answers and may produce unexpected results when batch files from different releases are used.

Verifying installation

To verify that TimesTen has been properly installed, check that the driver files are available and that the services are running:

  1. Confirm that the TimesTen 11.2.2 shortcut—for example, "TimesTen 11.2.2 (64-bit)"—appears under All Programs.

  2. From Administrative Tools, select Data Sources (ODBC). This opens the ODBC Data Source Administrator.

  3. Choose the Drivers tab. Check to see that the TimesTen Data Manager 11.2.2 driver is installed. (If you installed TimesTen Client, that driver should be listed as well. See the next section, "Verifying TimesTen Client and Server installation".) Click OK.

  4. From Administrative Tools, select Services and check that the TimesTen Data Manager 11.2.2 service has status "Started". (See "Starting and stopping the TimesTen daemon" in Oracle TimesTen In-Memory Database Operations Guide for related information.)

Verifying TimesTen Client and Server installation

Perform the following steps to verify that the Client and Server have been properly installed.

Note:

The instructions in this section are valid if you are installing 32-bit TimesTen on 32-bit Windows or 64-bit TimesTen on 64-bit Windows. However, if you are installing 32-bit TimesTen on 64-bit Windows, verify the TimesTen ODBC entries by executing the following, which is the 32-bit version of the ODBC Data Source Administrator:

%WINDIR%\SysWOW64\odbcad32.exe

  1. From Administrative Tools, select Data Sources (ODBC). This opens the ODBC Data Source Administrator.

  2. Choose the Drivers tab. Check to see that the TimesTen Client 11.2.2 driver is installed. (You should also see the TimesTen Data Manager 11.2.2 driver. See the preceding section, "Verifying installation".) Click OK.

    Note: If you install the 32-bit client in a 64-bit installation, you must use the 32-bit ODBC Data Source Administrator, mentioned in the note above, to view its driver entry.

  3. Choose the System DSN tab.

  4. Select the sampledbCS_1122 sample database and click Configure.

    Notes:

    • This step assumes you installed TimesTen Quick Start, which includes the sample databases.

    • The sampledb_1122 DSN is used for direct connections. The sampledbCS_1122 DSN is used for client/server connections.

    This opens the TimesTen Client Data Source Setup dialog.

  5. Click Test Oracle TimesTen Server Connection to attempt a connection to the server.

    The ODBC Administrator attempts to connect to the TimesTen Server and displays a message to let you know if it was successful. When you click this button, the TimesTen Client verifies the following:

    • ODBC, Windows sockets, and the TimesTen Client are installed on the computer.

    • The TimesTen Server you have selected is defined.

    • The TimesTen Server is running.

  6. Click Test Data Source Connection to attempt a connection to the data source on the TimesTen Server.

    The ODBC Data Source Administrator attempts to connect to the TimesTen data source and displays a dialog to let you know if it was successful. When you click Test Data Source Connection, the TimesTen Client verifies that:

    • The data source you have chosen is defined on the server.

    • The TimesTen Client can connect to the data source.

Informational messages on Windows systems

TimesTen writes error messages into the tterrors.log file. This file is located in the install_dir\srv\info directory. You can use the ttDaemonLog utility to view messages logged by the TimesTen Data Manager. For a description of the system administration utilities, see "Utilities" in the Oracle TimesTen In-Memory Database Reference.

Uninstalling TimesTen on Windows systems

You can uninstall TimesTen on Windows as you would any other program.

Important:

Before uninstalling, ensure that you do not have any databases or important files under the TimesTen installation directory. See "Considerations for locations of database files and other user files" for related information.
  1. Go to Add/Remove Programs (or Programs and Features in Windows 7).

  2. In the list of programs, select TimesTen. For example, select "Oracle TimesTen In-Memory Database 11.2.2 (64-bit)".

  3. Click Remove (or Uninstall in Windows 7).

    You will be asked whether you want to remove DSN definitions associated with the installation. If you answer Yes, then all definitions are removed. This includes user-defined DSNs as well as those created by the TimesTen installation process.

    Important: If you are uninstalling as part of the equivalent of an in-place upgrade (discussed in "Performing an in-place upgrade"), you must keep your DSNs.

To verify that removal was successful, check the following:

  • TimesTen 11.2.2 has been removed from All Programs.

  • TimesTen Data Manager 11.2.2 has been removed from the Services list.

  • The TimesTen 11.2.2 drivers have been removed from the Drivers tab in the ODBC Data Source Administrator.

See "Verifying installation" for information about the Services list and ODBC Data Source Administrator.

Installing TimesTen on Exalogic systems

To install TimesTen on an Exalogic system, you follow the prompts in the TimesTen installer as described in the procedures in "Installing TimesTen on UNIX systems". Also, ensure that you have met the prerequisites for Oracle Linux installations. See "Linux prerequisites"

It is recommended that you install TimesTen on each of the compute nodes of an Exalogic system.

Note:

Installing TimesTen binaries on the shared disk for use on multiple compute nodes is not supported.

Some considerations on the location of the TimesTen installation files are:

It is strongly recommended that the TimesTen installation, checkpoint and transaction log files for each node be stored in the locations shown in Table 1-1.

Table 1-1 Installation, checkpoint file, and transaction log file locations

Component Directory

Installation

/non-NFS_mounted_file_system_path/TimesTen/TTinstance

Database

/u01/machinename/general/path or /u01/common/images/machinename/TTinstance

Log directory

/u01/machinename/general/username/TTinstance


Installing Oracle Clusterware for use with TimesTen

Install Oracle Clusterware per instructions in the Oracle Clusterware Administration and Deployment Guide.

Be aware that TimesTen 11.2.2 supports Clusterware versions 11.2.0.2 and 11.2.0.3 only. (TimesTen 11.2.1 supports Clusterware versions 11.1.0.7, 11.2.0.2, and 11.2.0.3.)

Follow these recommendations:

  • Create an NFS share on the ZFS 7320 Storage Appliance to be used for both OCR and the voting disk. Specific NFS parameters are required so that the NFS share can be used as a voting disk, refer to the Oracle Clusterware Administration and Deployment Guide for more details.

  • Install Clusterware on the ZFS 7320 Storage Appliance. The solid state disk (SSD) file system may not have sufficient space.

    Note:

    Installing in a shared Oracle home is not recommended as it does not allow rolling upgrades of Oracle Clusterware. Instead, each compute node should have its own installation of Clusterware.
  • Install Clusterware on each compute node. The path to the Clusterware installation must be the same on each compute node. Therefore, it is required to set up a directory structure that allows each compute node to use the same path to access its own Clusterware installation.

    • On the shared storage, a separate directory exists for each compute node:

      • For compute node 1, the directory is:

        /export/compute_node_1/general
        
      • For compute node 2, the directory is:

        /export/compute_node_2/general
        
      • For compute node n, the directory is:

        /export/compute_node_n/general
        
    • Use NFS mount to map the node specific directory to the same path on each compute node:

      • On host 1, do as follows.

        mkdir -p /opt/oracle
        mount storage-server:/export/compute_node_1/general /opt/oracle
        
      • On host 2, do as follows.

        mkdir -p /opt/oracle
        mount storage-server:/export/compute_node_2/general /opt/oracle
        
      • On host n, do as follows.

        mkdir -p /opt/oracle
        mount storage-server:/export/compute_node_n/general /opt/oracle
        
      • On each host, install Oracle Clusterware in /opt/oracle/crs.

ODBC installation

The ODBC SDK redistributable components are installed in C:\Windows\System32 on Windows systems. Microsoft only permits TimesTen to redistribute portions of the ODBC SDK; those portions are installed automatically (if they are not present). Other components—Microsoft sample programs, online help files, and C language header files—are available separately from Microsoft as part of the Microsoft ODBC SDK, which can be installed separately as required. Additionally, the ODBC C language header files and ODBC online help are bundled as part of Microsoft Visual Studio .NET 2003 or Microsoft Visual Studio 2005, 2008, or 2010. Most TimesTen developers do not need to install the SDK separately.

On UNIX systems, no separate SDK installation is required.

Environment variables

This section describes various environment variables that may have to be set, depending on the features of TimesTen that your application uses. The following table summarizes, in alphabetical order, the environment variables detailed in this section and other parts of this guide. Some of these environment variables are platform-specific.

Environment variable Settings For additional information, see:
LIB, LIBPATH, LD_LIBRARY_PATH, LD_LIBRARY_PATH_64 Include the lib directory under the TimesTen installation directory. "Shared library path environment variable"
NLS_LANG Set this to specify a character set for the connection. The setting in the sys.odbc.ini or user odbc.ini file is used by default if not overridden by NLS_LANG. Setting the character set explicitly is recommended. The default is typically AMERICAN_AMERICA.US7ASCII.

Notes:

  • TimesTen uses NLS_LANG for the character set only, ignoring what precedes the dot ("."). You can specify just the character set as follows (with the dot still required): NLS_LANG=.WE8ISO8859P1

  • On Windows, the NLS_LANG setting is searched for in the registry, HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\NLS_LANG, if it is not in the environment. If your program has trouble connecting to TimesTen, confirm the NLS_LANG setting is valid and indicates a character set supported by TimesTen. TimesTen uses the Oracle Instant Client to make these connections.

"Character sets" in Oracle TimesTen In-Memory Database C Developer's Guide. This discussion is oriented toward OCI but includes more general information and a link to Oracle Database documentation for further discussion.

"Supported character sets" in Oracle TimesTen In-Memory Database Reference.

ODBCINI Include the location where the odbc.ini file used by TimesTen databases is to be found. "ODBCINI environment variable"
PATH Include the bin directory under the TimesTen installation directory. On Windows, also include the path to the Oracle Database installation if you are using the IMDB Cache option. "PATH environment variable", "Shared library path environment variable" and "Installing TimesTen on Windows systems"
SYSODBCINI Set to the location where the sys.odbc.ini file used by TimesTen system databases is to be found. The default location is usually sufficient, so this can usually be left unset. "SYSODBCINI environment variable"
SYSTTCONNECTINI Set to the location for the sys.ttconnect.ini file used by TimesTen Client applications to define logical server names. The default location is usually sufficient, so this can usually be left unset. "SYSTTCONNECTINI environment variable"
TMP or TMPDIR Set to the location of the temporary directory. TimesTen uses this directory during recovery and other operations. "Default installation directories"
TNS_ADMIN If using IMDB Cache, set to the location of the tnsnames.ora file. Required if you are using the IMDB Cache option. "TNS_ADMIN environment variable"
Java For Java applications, there are certain environment variables that must be set. "Java environment variables"

The following sections describe environment variables in TimesTen and how to set them.

Setting environment variables for TimesTen

If, after installation, you want to set the environment variables to standard TimesTen settings, source the ttenv script on UNIX or run the ttenv.bat batch file on Windows. This includes setting the path and classpath (and library path on UNIX systems) so that TimesTen utilities can be executed, among other things. You must invoke ttenv before starting TimesTen in order for any of the changes to take effect.

For UNIX platforms, use the appropriate script in the install_dir/bin directory, either ttenv.sh or ttenv.csh, depending on your shell. Following are examples, assuming your local directory is the bin directory (otherwise specify the full path).

For a Bourne-type shell, such as sh, bash, zsh, or ksh:

. ./ttenv.sh

For a csh or tcsh shell:

source ttenv.csh

For a Windows platform, execute the install_dir\bin\ttenv.bat batch file.

Note:

On Windows, the path, classpath, and library path are already set during installation if "Register environment variables" is enabled, which is the case by default.

Environment variable descriptions

Key environment settings are accomplished through ttenv as noted in the preceding section. In case further information is needed, the following sections provide more details on environment variables and indicates which are set by ttenv.

The following environment variables are described:

PATH environment variable

TimesTen provides utilities for managing and debugging TimesTen applications. To make these utilities available, include install_dir/bin in the PATH setting.

Note:

This variable is set by ttenv or, on Windows, during installation if environment variables are registered (default).

ODBCINI environment variable

TimesTen applications use the odbc.ini file to define data sources and their connection attributes. (For a description of connection attributes, see "Connection Attributes" in the Oracle TimesTen In-Memory Database Reference.) By default on UNIX platforms, TimesTen first looks for the user odbc.ini file in the home directory of the user running the TimesTen application. To override the name and location of this file at run-time, set the ODBCINI environment variable to indicate a desired path and file name before launching the TimesTen application.

If TimesTen cannot locate a user DSN file, TimesTen looks for the sys.odbc.ini file in install_dir/info. (Also see the next section about the SYSODBCINI environment variable.) For more information, see "Overview of user and system DSNs" in Oracle TimesTen In-Memory Database Operations Guide.

SYSODBCINI environment variable

TimesTen applications use the sys.odbc.ini file to define system data sources and their connection attributes. (For a description of connection attributes, see "Connection Attributes" in the Oracle TimesTen In-Memory Database Reference.) Any user can use a system data source. On Windows, system DSNs are defined from the System DSN tab of the ODBC Data Source Administrator. On UNIX, system DSNs are defined in the file install_dir/info/sys.odbc.ini. To override the name and location of this file at run-time, set the SYSODBCINI environment variable to the path name of a sys.odbc.ini file before launching the TimesTen application.

TimesTen first looks for a DSN in the user odbc.ini file. (Also see the previous section about the ODBCINI environment variable.) If it is not found there, TimesTen looks in the sys.odbc.ini file.

For more information, see "Overview of user and system DSNs" in Oracle TimesTen In-Memory Database Operations Guide.

SYSTTCONNECTINI environment variable

TimesTen client applications use the sys.ttconnect.ini file to define logical server names. For a description of logical server names, see "Working with the TimesTen Client and Server" in the Oracle TimesTen In-Memory Database Operations Guide. By default on UNIX platforms, TimesTen looks in install_dir/info/sys.ttconnect.ini. To override the name and location of this file at run-time, set the SYSTTCONNECTINI environment variable before launching the TimesTen Client application.

On Windows systems, logical server names can be configured using the ODBC Data Source Administrator.

TNS_ADMIN environment variable

On platforms where IMDB Cache is supported, to work with Oracle Database data, you must set the TNS_ADMIN environment variable to indicate the directory of the tnsnames.ora file.

Note:

On UNIX systems, this variable is set if you source ttenv. On Windows, you can optionally set it during installation when prompted.

The ttmodinstall utility with the -tns_admin option enables you to set a value for this environment variable after installation. See the Oracle TimesTen In-Memory Database Reference for more details on ttmodinstall.

Shared library path environment variable

On Linux systems, add install_dir/lib to the LD_LIBRARY_PATH environment variable.

On Solaris systems, add install_dir/lib to the LD_LIBRARY_PATH or LD_LIBRARY_PATH_64 environment variable, as appropriate.

On AIX systems, add install_dir/lib to the LIBPATH environment variable.

On Windows systems, add install_dir\lib to the LIB environment variable.

Note:

On UNIX systems, the applicable variable is set if you source ttenv. On Windows, LIB is set during installation if environment variables are registered (default).

Java environment variables

The following sections provide more detail about the environment variables that affect the environment for TimesTen Java applications.

Set the CLASSPATH variable

Java classes and class libraries are found on CLASSPATH. Before executing a Java program that loads any of the TimesTen JDBC drivers, the CLASSPATH environment variable must contain the class library file:

install_dir/lib/ttjdbcjdk_ver.jar

Where jdk_ver indicates the version of the JDK that you are using. For example, for JDK 5.0, jdk_ver is 5 and the file name would be ttjdbc5.jar. For JDK 6, jdk_ver is 6 and the file name would be ttjdbc6.jar.

Notes:

  • This variable is set by ttenv or, on Windows, during installation if environment variables are registered (default).

  • If multiple JAR files are listed in the CLASSPATH, ensure the TimesTen JAR file is listed first.

On UNIX, CLASSPATH elements are separated by colon. For example (sh type shell):

CLASSPATH=.:install_dir/lib/ttjdbc6.jar
export CLASSPATH

Or (csh type shell):

setenv CLASSPATH .:install_dir/lib/ttjdbc6.jar

On Windows, CLASSPATH elements are separated by semicolons.

Also, on Windows, do not use quotes when setting the CLASSPATH environment variable even if a directory path name contains spaces.

For example, this is correct:

set CLASSPATH=.;install_dir\lib\ttjdbc6.jar

This is incorrect:

set CLASSPATH=.;"install_dir\lib\ttjdbc6.jar"

If in doubt about the JDK version you have installed on your system, enter:

> java -version

If you are going to use the JMS/XLA interface, then you also must add the following to your CLASSPATH:

install_dir/lib/timestenjmsxla.jar
install_dir/3rdparty/jms1.1/lib/jms.jar
install_dir/lib/orai18n.jar

For example, your CLASSPATH would look like the following example (replacing install_dir as appropriate):

.:install_dir/lib/ttjdbc6.jar:install_dir/lib/timestenjmsxla.jar
:install_dir/3rdparty/jms1.1/lib/jms.jar:install_dir/lib/orai18n.jar

By default, JMS/XLA looks for a configuration file called jmsxla.xml in the current working directory. To use another name or location for the file, you must specify it as part of the environment variable in the InitialContext class and add the location to the CLASSPATH setting. See Oracle TimesTen In-Memory Database Java Developer's Guide for more information about the jmsxla.xml configuration file.

Set the shared library path variable

Before running a Java program that loads the TimesTen JDBC driver, the shared library path for your system environment variable must be set to include the TimesTen install_dir/lib directory. The name of the variable used for the shared library path depends on the system used.

System Name of Variable
Linux LD_LIBRARY_PATH
Solaris LD_LIBRARY_PATH
AIX LIBPATH
Windows PATH

Set the THREADS_FLAG variable (UNIX only)

The TimesTen JDBC driver uses native threads. Green threads are not supported.

On some UNIX platforms, to use the native threads package, you must set the THREADS_FLAG environment variable to native. How you set the flag depends on your shell.

In csh, the syntax is:

setenv THREADS_FLAG native

In sh, the syntax is:

THREADS_FLAG=native
export THREADS_FLAG
Set the PATH variable

Ensure the javac and java executables are both on your executable search path.

TimesTen Quick Start

During installation, you have the option of installing TimesTen Quick Start, which includes a variety of tutorials, demo applications, and other resources. If you choose to install Quick Start, it is installed by default under the directory install_dir/quickstart. On UNIX you have the option of specifying an alternative location. Regardless of where you install Quick Start, the home page for further information is install_dir/quickstart.html.

Quick Start provides tutorials, demos, and sample code for administration, access control, application development, replication, and caching, including the following areas.

Configuration and setup:

Application development:

Performance and best practices:

Through the Quick Start home page, you can find information to set up and run the demos.

Documentation installation

TimesTen documentation is installed along with the TimesTen product unless you choose not to install the documentation. Documents are provided in HTML and PDF format. The HTML can be viewed in your browser. The PDF can be viewed with the Adobe Acrobat Reader. If you do not have the Acrobat Reader, it is available from the Adobe Systems website: http://www.adobe.com

Documentation is installed in the install_dir/doc directory.

Note that TimesTen documentation is also available through the Oracle Technology Network at the following location:

http://www.oracle.com/technetwork/products/timesten/documentation/index.htm

This version may be more current than the version installed with TimesTen.

Installation problems

To avoid problems during installation, ensure you have met all prerequisites. Using information in this installation guide and the release notes, check that: