4.4.1.2 Server Script Syntax

The server.sh(.bat) 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.sh(.bat) 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.

-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).

--no-db

no-db do not configure the database; only install the ORE module and libraries associated with Embedded R Execution

--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.