4.3.2 Install OML4R Server Using server.sh

The server.sh script supports a set of command-line arguments that control its activities. It can be run in interactive, batch, or hybrid mode. If run without any arguments, the script installs or upgrades the OML4R Server in interactive mode and, by default, attempts to install the required supporting packages.

The command-line arguments for server.sh are described in the table below. You can view a list of these arguments, along with brief descriptions, by running the following command on a Linux system:

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

Table 4-3 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 OML4R Server from Oracle Database 23ai.

-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 in Uninstall OML4R Server from Oracle Database 23ai

--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 in Uninstall OML4R Server from Oracle Database 23ai

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

Follow the below instructions to install the OML4R Server on both the Container Database Root (CDB$ROOT) and Pluggable Databases (PDBs) within your Oracle Database 23.7 environment.

  1. Install OML4R Server on CDB$ROOT::
    $ ./server.sh
     
    Oracle R Enterprise 2.0 Server.
     
    Copyright (c) 2012, 2022 Oracle and/or its affiliates. All rights reserved.
     
    Checking platform .................. Pass
    Checking R ......................... Pass
    Checking R libraries ............... Pass
    Checking ORACLE_HOME ............... Pass
    Checking ORACLE_SID ................ Pass
    Checking sqlplus ................... Pass
    Checking ORACLE instance ........... Pass
    Checking CDB/PDB ...................   Perform operation in a root container? [yes or no]yes
    Pass
    Checking ORE ....................... Pass
    
    Choosing RQSYS tablespaces
      PERMANENT tablespace to use for RQSYS [list]: 
    SYSAUX
    SYSTEM
    USERS
      PERMANENT tablespace to use for RQSYS [list]: SYSAUX
      TEMPORARY tablespace to use for RQSYS [list]: 
    TEMP
      TEMPORARY tablespace to use for RQSYS [list]: TEMP
     
    Current configuration
      R Version ........................ R version 4.4.1 (2024-06-14)
      R_HOME ........................... /usr/lib64/R
      R_LIBS_USER ...................... <ORACLE HOME PATH>/R/library
      ORACLE_HOME ...................... <ORACLE HOME PATH>
      ORACLE_SID ....................... orcl
      CDB .............................. CDB$ROOT
     
      Existing R Version ............... 
      Existing R_HOME .................. 
      Existing ORE data ................ None
      Existing ORE code ................ None
      Existing ORE libraries ........... None
     
      RQSYS PERMANENT tablespace ....... SYSAUX
      RQSYS TEMPORARY tablespace ....... TEMP
     
      Operation ........................ Install/Upgrade
     
    Proceed? [yes] yes
     
    Removing R libraries ............... Pass
    Installing R libraries ............. Pass
    Installing ORE libraries ........... Pass
    Configuring the database ............ Pass
    Installing ORE packages ............ Pass
    Removing ORE script ................ Pass
    Creating ORE script ................ Pass
    Installing migration scripts ....... Pass
    Installing supporting packages ..... Pass
     
    Done
    
  2. Install OML4R Server on PDBs.
    $ ./server.sh
     
    Oracle R Enterprise 2.0 Server.
     
    Copyright (c) 2012, 2022 Oracle and/or its affiliates. All rights reserved.
     
    Checking platform .................. Pass
    Checking R ......................... Pass
    Checking R libraries ............... Pass
    Checking ORACLE_HOME ............... Pass
    Checking ORACLE_SID ................ Pass
    Checking sqlplus ................... Pass
    Checking ORACLE instance ........... Pass
    Checking CDB/PDB ...................   Perform operation in a root container? [yes or no]no
      PDB to use for ORE installation [list]: 
    ORCLPDB
      PDB to use for ORE installation [list]: ORCLPDB
    Checking CDB/PDB ................... Pass
    Checking ORE ....................... Pass
     
    Choosing RQSYS tablespaces
      PERMANENT tablespace to use for RQSYS [list]: 
    EXAMPLE
    SYSAUX
    SYSTEM
    USERS
      PERMANENT tablespace to use for RQSYS [list]: SYSAUX
      TEMPORARY tablespace to use for RQSYS [list]: TEMP
     
    Current configuration
      R Version ........................ R version 4.4.1 (2024-06-14)
      R_HOME ........................... /usr/lib64/R
      R_LIBS_USER ...................... <ORACLE HOME PATH>/R/library
      ORACLE_HOME ...................... <ORACLE HOME PATH>
      ORACLE_SID ....................... orcl
      PDB .............................. ORCLPDB
     
      Existing R Version ............... R version 4.4.1 (2024-06-14)
      Existing R_HOME .................. /usr/lib64/R
      Existing ORE data ................ None
      Existing ORE code ................ None
      Existing ORE libraries ........... 2.0
     
      RQSYS PERMANENT tablespace ....... SYSAUX
      RQSYS TEMPORARY tablespace ....... TEMP
     
      Operation ........................ Install/Upgrade
     
    Proceed? [yes] yes
     
    Removing R libraries ............... Pass
    Installing R libraries ............. Pass
    Configuring the database ............ Pass
    Removing ORE script ................ Pass
    Creating ORE script ................ Pass
    Installing supporting packages ..... Pass
     
    Done