About the Server Script

A single script called server manages the installation and administration of OML4R Server for Oracle Database 12c and earlier releases.

You can rerun the server script whenever you need to install, uninstall, upgrade, or configure server-side components of OML4R.

The following topics provide details about the script:

Overview of Server Script Operations

Describes the operations you can perform with the server script.

The server script supports the following operations:

  • Installs OML4R Server

  • Uninstalls OML4R Server

  • Upgrades OML4R Server and migrates data from the earlier installation

  • Installs the supporting packages, if they are available

  • Creates or configures a database user, if one does not exist

Note:

You can use the server script to install the supporting packages and create users, or you can choose to perform these tasks separately, as described in the following sections:

Server Script Syntax

The server script supports a set of command-line arguments that direct its activities.

The script can be run in interactive mode, in batch mode, or in hybrid mode. If you run the script without arguments, it installs or upgrades OML4R Server in interactive mode; it attempts to install the supporting packages; and it creates or configures a database user.

The command-line arguments for the server script are described in the following table. The arguments for the script are the same for Linux, UNIX, and Windows. You can obtain a listing of the arguments with brief descriptions by executing the following on a Linux or UNIX system:

./server.sh -h
or
./server.sh --help

On a Windows system, you can obtain a listing of the arguments with brief descriptions by executing the following:

server.bat -h
or
server.bat --help

Table 4-4 Server Script Command-Line Arguments

Argument Description

-i, --install

Install or upgrade OML4R Server.

An installation or upgrade includes the following by default:

  • Installation of the supporting packages if they are present.

  • Creation or configuration of a database user if one does not exist.

-u, --uninstall

Uninstall OML4R Server:

  • When used with --keep (the default), the script removes the RQSYS metadata and PL/SQL packages from the database but retains the libraries and R packages under Oracle home (partial uninstall).

  • When used with --full, the script removes the libraries and R packages under Oracle home in addition to the RQSYS metadata and PL/SQL packages in the database. (full uninstall).

See Uninstall Oracle Machine Learning for R.

-s, --setup-user

Create or configure a database user for OML4R (the default).

-y

Never prompt.

--ask

Interactive mode (the default).

--keep

When uninstalling OML4R Server, keep the R packages and libraries under Oracle home but remove the database objects. Allows OML4R support to be removed from a single database instance or pluggable database (PDB) without affecting other databases in Oracle home.

See Performing a Partial Uninstall.

--full

When uninstalling OML4R Server, remove the R packages and libraries under Oracle home in addition to the database objects.

See Performing a Full Uninstall.

--no-supp

When combined with --install, prevents installation of the supporting packages. By default the supporting packages are installed if they are available.

--supp

Install supporting packages (the default).

--pdb NAME

The name of a pluggable database (PDB) in a multitenant container database (CDB).

Multitenant architecture enables an Oracle database to function as a container database that includes zero, one, or many pluggable databases. For information about multitenant architecture, see Oracle Database Concepts.

--perm PERM

Permanent tablespace for RQSYS.

--temp TEMP

Temporary tablespace for RQSYS.

--user-perm PERM

Permanent tablespace for OML4R user.

--user-temp TEMP

Temporary tablespace for OML4R user.

--user USER

OML4R database user name.

Server Script Examples

Example of using the server script.

See the following topics for examples of using the server script:

See Also:

Example A-1 for an example with output

A Default Interactive Installation

Example of a default installation of OML4R Server.

If your Linux or UNIX or Windows system meets the requirements specified in System Requirements, then this command performs a default, first-time installation of OML4R Server:

For Linux or UNIX:

./server.sh

For Windows:

server.bat

As shown in Example A-1, a default, interactive installation performs the following:

  • Prints out information about the environment

  • Prompts for the password and permanent and temporary tablespaces for rqsys

  • Prompts whether to install the supporting packages. (Installs the supporting packages by default if they are available.)

  • Prompts whether to create a user account for OML4R. (Creates a user by default if one does not exist.) When creating a user, prompts for the permanent and temporary tablespaces.

A Default Batch Installation

Example of installing OML4R Server in batch mode.

This example shows an installation like the one in A Default Interactive Installation, but specified to run in batch mode.

For Linux or UNIX:

./server.sh  -y  --install  --setup-user  --perm SYSAUX  --temp TEMP  
          --user-perm USERS  --user-temp TEMP  --user OML_USER

For Windows:

server.bat  -y  --install  --setup-user  --perm SYSAUX  --temp TEMP  
          --user-perm USERS  --user-temp TEMP  --user OML_USER