Table of Contents
- List of Examples
- List of Tables
- Title and Copyright Information
- Preface
- Changes in Release 23.1 Oracle REST Data Services Installation and Configuration Guide
-
1
Oracle REST Data Services
Installation Checklist
- 1.1 System Requirements
- 1.2 Supported Java EE Application Servers
- 1.3 Supported Oracle APEX Versions
- 1.4 ORDS Installer Privileges Script
- 1.5 Privileges Granted to the Oracle REST Data Services Users
- 1.6 About the Database Users Used by Oracle REST Data Services
- 1.7 About Command-Line Interface
- 1.8 About Online Help
-
2
Installing and Configuring Oracle REST Data
Services
-
2.1
Installing Oracle REST Data Services
- 2.1.1 Downloading ORDS
- 2.1.2 Setting Up the Configuration Folder Structure
-
2.1.3
Interactive Command-Line Interface
Installation
- 2.1.3.1 Entering a Number to Select the Type of Installation
- 2.1.3.2 Entering a Number to Select the Database Pool
- 2.1.3.3 Entering the Database Pool Name
- 2.1.3.4 Entering a Number to Select the Database Connection
- 2.1.3.5 Entering the Database Host Name
- 2.1.3.6 Entering the Database Listener Port
- 2.1.3.7 Entering the Database Service Name
- 2.1.3.8 Entering the TNS Location
- 2.1.3.9 Entering a Number to Select the TNS Network Alias
- 2.1.3.10 Entering the Custom Database URL
- 2.1.3.11 Entering the Administrator Username
- 2.1.3.12 Entering the Database Password
- 2.1.3.13 Entering the Default Tablespace
- 2.1.3.14 Entering a Number to Select Additional Feature(s)
- 2.1.3.15 Entering a Number to Configure and Start ORDS in Standalone Mode
- 2.1.3.16 Entering a Number to Use HTTP or HTTPS Protocol
- 2.1.3.17 Entering the HTTP Port
- 2.1.3.18 Entering the HTTPS Port
- 2.1.3.19 Entering a Number to Select the Certificate Type
- 2.1.3.20 Entering the SSL Hostname
- 2.1.3.21 Entering the Path for the SSL Certificate
- 2.1.3.22 Entering the Path for the SSL Certificate’s Private Key
- 2.1.3.23 Entering the APEX Static Resources Location
- 2.1.4 Non-Interactive Command-Line Interface Installation (Silent)
- 2.2 Repairing the Oracle REST Data Services Installation
- 2.3 Upgrading Oracle REST Data Services
-
2.4
Uninstalling Oracle REST Data Services
-
2.4.1
Interactive Uninstall CLI
- 2.4.1.1 Entering a Number to Select the Database Pool
- 2.4.1.2 Entering a Number to Select the Database Connection Type
- 2.4.1.3 Entering the Database Host Name
- 2.4.1.4 Entering the Database Listener Port
- 2.4.1.5 Entering the Database Service Name
- 2.4.1.6 Entering the TNS Location
- 2.4.1.7 Entering a Number to Select the TNS Network Alias
- 2.4.1.8 Entering the Custom Database URL
- 2.4.1.9 Entering the Administrator Username
- 2.4.1.10 Entering the Database Password for SYS AS SYSDBA
- 2.4.1.11 Entering an Option for Uninstalling ORDS
- 2.4.2 Non-Interactive Uninstall CLI
-
2.4.1
Interactive Uninstall CLI
- 2.5 Updating the Configuration Settings
-
2.1
Installing Oracle REST Data Services
- 3 Configuring Oracle REST Data Services for Multiple Databases
- 4 Overview of Schema Level Configuration Override
-
5
Miscellaneous Configuration Options of Oracle
REST Data Services
- 5.1 Using the REST Enabled SQL Service with MySQL Database
- 5.2 Configuring Jetty in ORDS Standalone Mode
- 5.3 Support for Oracle RAC Fast Connection Failover
- 5.4 Configuring ORDS with Kerberos Setup
- 5.5 Authorizing Oracle REST Data Services to Access Oracle Data Guard Protected Users
- 5.6 Configuring REST-Enabled SQL Service Settings
- 5.7 Configuring the Maximum Number of Rows Returned from a Query
- 5.8 Configuring ICAP Server Integration for Virus Scan
- 5.9 Configuring the Custom Error Pages
- 5.10 Managing ORDS Administrator Privilege
- 5.11 Managing ORDS Runtime Privilege
- 5.12 Using OAuth2 in Non-HTTPS Environments
- 5.13 Configuring ORDS Metadata Cache
-
6
Deploying and Monitoring Oracle REST Data
Services
-
6.1
Deploying Oracle REST Data Services
- 6.1.1 Serve Commands for Running in Standalone Mode
-
6.1.2
Oracle WebLogic Server
- 6.1.2.1 About Oracle WebLogic Server
- 6.1.2.2 Configuring Oracle APEX Images
- 6.1.2.3 Launching the Administration Server Console
- 6.1.2.4 Deploying ORDS on Oracle WebLogic Server
- 6.1.2.5 Configuring WebLogic to Handle HTTP Basic Challenges Correctly
- 6.1.2.6 Verifying the State and Health of ords and i
- 6.1.3 Apache Tomcat
- 6.1.4 Oracle Cloud Infrastructure
- 6.2 Monitoring Oracle REST Data Services
- 6.3 Using OpenTelemetry with Oracle REST Data Services
-
6.1
Deploying Oracle REST Data Services
-
7
Using the Multitenant Architecture with Oracle REST Data Services
- 7.1 Setting Up ORDS in a CDB Environment
-
7.2
Setting Up ORDS in an Application Container
- 7.2.1 Prerequisites for Creating ORDS in an Application Container
- 7.2.2 Installing ORDS in the Application Root Container
- 7.2.3 Creating an Application Seed
- 7.2.4 Creating an Application PDB from the Application Seed
- 7.2.5 Configuring the PLSQL Gateway for APEX
- 7.2.6 ORDS Configuration Files Setup
- 7.2.7 Running ORDS
- 7.2.8 Upgrading ORDS in the Application Container
- 7.2.9 Uninstalling ORDS from the Application Container
- 7.2.10 Verifying ORDS in the Application Container
- 7.3 Making All PDBs Addressable by Oracle REST Data Services (Pluggable Mapping)
-
8
Installing and Configuring Customer Managed
ORDS on Autonomous Database
- 8.1 About Customer Managed Oracle REST Data Services on Autonomous Database
- 8.2 Preinstallation Tasks
-
8.3
ORDS Command-Line Interface for
Customer Managed ORDS
-
8.3.1
Interactive Install for ADB
Command Line Interface
- 8.3.1.1 Customer Managed ORDS Command Options
-
8.3.1.2
Interactive Installation
Prompts
- 8.3.1.2.1 Entering a Number to Select the Database Pool
- 8.3.1.2.2 Entering the Database Pool Name
- 8.3.1.2.3 Entering the Autonomous Database Wallet Path
- 8.3.1.2.4 Enter a Number to Select the TNS Network Alias
- 8.3.1.2.5 Enter the Administrator Username
- 8.3.1.2.6 Enter the Database Password for ADMIN
- 8.3.1.2.7 Entering the ORDS Runtime Database Username
- 8.3.1.2.8 Entering the Database Password for ORDS_PUBLIC_USER2
- 8.3.1.2.9 Entering the PL/SQL Gateway Database Username
- 8.3.1.2.10 Enter the Database Password for ORDS_PLSQL_GATEWAY2
- 8.3.1.2.11 Entering a Number to Select and Enable Additional Feature
- 8.3.1.2.12 Enter a Number to Configure and Start ORDS
- 8.3.1.2.13 Entering a Number to Select a Protocol
- 8.3.1.2.14 Entering the HTTP Port
- 8.3.1.2.15 Entering the HTTPS Port.
- 8.3.1.2.16 Entering the APEX Static Resources Location
- 8.3.2 Silent Installation of ADB on Command-Line Interface
-
8.3.1
Interactive Install for ADB
Command Line Interface
- 9 Oracle API for MongoDB Support
- 10 Migration of Legacy Configuration
-
A
Non-Interactive ORDS CLI Commands
Examples
- A.1 Non-Interactive Install/Upgrade
- A.2 Non-Interactive Install/Upgrade (create a proxied PLSQL Gateway User)
- A.3 Non-Interactive Install/Upgrade (specify PLSQL Gateway User and not using RESTful Services)
- A.4 Non-Interactive Install/Upgrade (disable a configured PLSQL Gateway)
- A.5 Non-Interactive Uninstall ORDS
- A.6 config CLI Examples
- B ORDS Legacy Commands and New ORDS CLI Commands
- C About the Oracle REST Data Services Configuration Files
- Index