1 Oracle REST Data Services Installation Checklist
This chapter provides information about supported platforms, system requirements, and Database privileges required for using ORDS .
1.1 System Requirements
Oracle REST Data Services system requirements are as follows:
-
A currently supported version of Oracle Database.
See Also:
Oracle Lifetime Support Policy - Use one of the following:
- Oracle Java version 11, 17, or 21
- Oracle GraalVM Enterprise Edition for Java version 11, 17, or 21
Note:
On Linux system, if the Oracle Java version is lower than 11, then the installation fails with an error message. For example:Error: ORDS requires Java 11 and above to run. Found Java version 1. Please set JAVA_HOME to appropriate version and update PATH if necessary.So, you must set
On Windows system, the user is re-directed to the Java download page.JAVA_HOMEto the appropriate version and update the PATH if required. -
Web browser requirements: Refer to Oracle Software Web Browser Support Policy for more information.
Note:
Oracle APEX is not a prerequisite for using Oracle REST Data Services.
If Oracle APEX is installed and if RESTful services have been configured during the installation (see the step Configuring Oracle REST Data Services in Oracle Application Express Installation Guide), then Oracle REST Data Services supports it.
1.1.1 GraalVM Configuration
To operate, Oracle REST Data Services requires a Java Runtime Environment. Customers can choose to use a supported Oracle GraalVM for improved performance in their runtime environment. It is not mandatory.
However, certain features in ORDS require the Java Runtime Environment to be
a GraalVM with specific Graal components installed. The dependent Graal component for
such features is mentioned in the documentation section. The most common dependency is
on the Graal.js component for JavaScript support.
gu list command to determine the components
available:
gu list
ComponentId Version Component name Stability
----------------------------------------------------------------------------------------
graalvm 23.0.1 GraalVM Core Supported
icu4j 23.0.1 ICU4J Supported
js 23.0.1 Graal.js Supported
regex 23.0.1 TRegex SupportedIf the JavaScript component is not listed as an available component, then install it
using the gu install js command. Refer to GraalVM documentation for
more information on the Graal Updater command utility and the capabilities of the
various Graal components.
Note:
1.3 Supported Oracle APEX Versions
Oracle REST Data Services supports the currently supported versions of APEX.
See Also:
The Oracle APEX (Formerly HTML DB) table in the ORACLE INFORMATION-DRIVEN SUPPORT document for supported versions of APEX.1.4 ORDS Installer Privileges Script
This section describes about the script file that provides privileges to the user to install, upgrade, repair, and uninstall ORDS.
Note:
This script is used when you do not want to use SYS AS SYSDBA to install, upgrade, repair, and uninstall ORDS for Oracle PDB or Oracle 11g.The Oracle REST Data Services contains a script,
ords_installer_privileges.sql which is located in the
scripts/installer folder. The script provides the assigned database
user the privileges to install, upgrade, repair, and uninstall ORDS in Oracle
Database.
- Using SQLcl or SQL*Plus, connect to the Oracle Database instance. You must have a Database account with appropriate privileges for installing ORDS.
- Execute the following script providing the database
user:
SQL> @/path/to/scripts/installer/ords_installer_privileges.sql exampleuser SQL> exit
You must use the specified database user to install, upgrade, repair, and uninstall ORDS.
1.5 Privileges Granted to the Oracle REST Data Services Users
As part of the Oracle REST Data Services installation, privileges are granted to several users and roles:
ORDS_RUNTIME_ROLEroleORDS_RUNTIME_ROLEis grantedEXECUTEon the following packages if these packages are not grantedEXECUTEtoPUBLIC:SYS.DBMS_LOBSYS.DBMS_SESSIONSYS.DBMS_UTILITYSYS.WPIUTL
ORDS_RUNTIME_ROLEis granted the necessaryORDS_METADATAobject privileges to determine the repository version and to access the connection pool configurations.
ORDS_PUBLIC_USERuserORDS_PUBLIC_USERis granted connect to allow connection to the database.ORDS_PUBLIC_USERis granted role,ORDS_RUNTIME_ROLEto allow the user to act as an ORDS runtime user
ORDS_ADMINISTRATOR_ROLEroleORDS_ADMINISTRATOR_ROLEis granted EXECUTE onORDS_METADATA.ORDS_ADMINPL/SQL package.
PUBLICPUBLICis grantedEXECUTEonORDS_METADATA.ORDS_REPVERSIONview to allow the repository version to be queried by anyone.PUBLICis grantedSELECTon manyORDS_METADATAviews.PUBLICis grantedEXECUTEonORDS_METADATAPL/SQL packages that are available for developer users.
ORDS_METADATAschemaORDS_METADATAschema is granted on the following packages if these packages are not grantedEXECUTEonPUBLIC:SYS.DBMS_ASSERTSYS.DBMS_LOBSYS.DBMS_OUTPUTSYS.DBMS_SCHEDULERSYS.DBMS_SESSIONSYS.DBMS_UTILITYSYS.DEFAULT_JOB_CLASSSYS.HTPSYS.OWASYS.WPG_DOCLOAD
ORDS_METADATAis grantedSELECT(11g) orREAD(12c or later) on the following view if it is not grantedSELECTorREADtoPUBLIC:SYS.SESSION_PRIVS
ORDS_METADATAschema is grantedEXECUTEon the following packages:SYS.DBMS_CRYPTOSYS.DBMS_METADATA
ORDS_METADATAschema is grantedSELECT(11g) orREAD(12c or later) on the following views:SYS.DBA_OBJECTSSYS.DBA_ROLE_PRIVSSYS.DBA_TAB_COLUMNS
ORDS_METADATAschema is grantedSELECTincludingWITH GRANT OPTIONon the following views:SYS.USER_CONS_COLUMNSSYS.USER_CONSTRAINTSSYS.USER_OBJECTSSYS.USER_PROCEDURESSYS.USER_TAB_COLUMNSSYS.USER_TABLESSYS.USER_VIEWS
ORDS_METADATAschema is granted the following system privileges:ALTER USERCREATE ANY TRIGGERCREATE JOBCREATE VIEWCREATE PUBLIC SYNONYMDROP PUBLIC SYNONYM
ORDS_METADATAschema is granted the necessary object privileges to migrate Application Express REST data toORDS_METADATAtables.ORDS_METADATAschema is grantedORDS_ADMINISTRATOR_ROLE,ORDS_RUNTIME_ROLEroles with administrator option.
-
PUBLICis grantedSELECTon manyORDS_METADATAtables and views. -
PUBLICis grantedEXECUTEon PL/SQL packages that are available for users to invoke. -
ORDS_METADATAis grantedEXECUTEon the following packages if these packages are not grantedEXECUTEtoPUBLIC:SYS.DBMS_ASSERTSYS.DBMS_LOBSYS.DBMS_OUTPUTSYS.DBMS_SCHEDULERSYS.DBMS_SESSIONSYS.DBMS_UTILITYSYS.DEFAULT_JOB_CLASSSYS.HTPSYS.OWASYS.WPG_DOCLOAD
-
ORDS_METADATAis granted the necessary object privileges to migrate Application Express REST data toORDS_METADATAtables.
1.6 About the Database Users Used by Oracle REST Data Services
Oracle REST Data Services uses the following database users:
| User Name | Required | Description |
|---|---|---|
|
|
Yes |
Owner of the PL/SQL packages used for implementing many Oracle REST Data Services
capabilities. It is not accessed directly by Oracle REST Data Services; the Oracle REST Data
Services application never creates a connection to
the |
|
|
Yes |
User for Oracle REST Data Services to make an initial database connection for handling requests. Depending on the request, the user will proxy to the relevant Oracle REST Data Services-enabled schema or PL/SQL Gateway user to complete the requested action in the database. |
1.7 About Command-Line Interface
- Create, update, and list your ORDS configuration
- Add additional database pools to your configuration Install/upgrade
- Repair, or uninstall ORDS in the database
- Run ORDS in standalone mode
1.8 About Online Help
ords --helpTo show the details
of an ORDS command, specify the ORDS command followed by --help. If
you want additional details for a sub-command, then specify the
--help after the sub-command.
ords <command> --help
ords <command> <sub-command> --help-
ords install --help -
ords config --help
ords config set --help