Oracle REST Data Services 22.4.0.340.1044 Release Notes

Oracle REST Data Services 22.4.0.340.1044

Release Notes

Date: December 2022

Oracle REST Data Services on oracle.com

Support

Note - Autonomous Database Shared Subscribers

If you are running a customer-managed ORDS for your Autonomous Transaction Processing, Autonomous Data Warehouse, or Autonomous JSON Database, you must upgrade your customer-managed ORDS to the version used in your Autonomous Database Shared environment. Failure to do so could lead to service disruptions.

To determine the version of ORDS in your Autonomous Database Shared database run this query:

select ords.installed_version from dual;

Documentation

General

Getting Started

Feedback

Important Concepts to Keep In Mind

Revised Command Line Interface and Configuration Directory Structure

Command Line Interface

The java commands serviced from the WAR file are no longer supported. Attempting to run the following:

java -jar ords.war standalone
Will result in an error message, referring you to the docs. Instead you would run:
ords --config /path/to/config serve

Installation & Configuration

The ORDS program or script in the bin directory can be used to perform installs, changes to your configuration, changing the database passwords for your connection pools, and for creating ORDS users. To see a list of commands:

ords --help

Configuration Files Directory Layout

If upgrading from a previous version of ORDS, your existing configuration directory for ORDS and the files contained therein will be migrated to a new layout for versions 22.1 and higher.

You may migrate your settings using the ORDS migrate command, or you may perform a 22.1 install which will prompt ORDS to migrate your existing ORDS configuration to the new mapping for you.

ORDS standalone and default pool configuration settings are in a settings.xml file in a global subdirectory.

Connection pools are in a databases subdirectory. The intital database pool is named 'default' and has a '/' mapping pattern.

Subsequent pools will created such that the name of the pool also defines the mapping pattern.

Migration of Oracle APEX Restful Service Modules

Oracle APEX 22.1 and onwards no longer natively supports the serving of APEX Based Restful Service Modules. Existing APEX Based Restful Service Modules must be migrated to ORDS Resource Modules in order to avoid loss of service.

As migration will replace any previously migrated (and possibly further developed) APEX Based Restful Service Modules from an APEX Workspace, it is the responsibility of the customer to manually initiate the migration. To help with this, Oracle has provided a number of SQL scripts that can be found in the "migrate" folder in the top-level "scripts" folder of the ORDS distribution ZIP file. These scripts must be run as either a DBA or an ORDS "Installation" user.

SQL Developer Web

SQL Developer Web (SDW) is an ORDS hosted web application giving Oracle Database users the SQL Developer desktop experience in their browser.

SQL Developer Web provides a development interface for building and maintaining your ORDS based REST APIs, AUTOREST Enabled database objects, OAuth3 Clients, ORDS Privileges and Roles, as well as a SODA for REST graphical interface. For the best possible experience developer REST APIs for ORDS, we reccommend you use SQL Developer Web.

For consistent representation of date values in SQL Developer Web, ORDS should be run in the UTC timezone. This is set automatically when using the

ords
command line interface. When deploying ORDS to Apache Tomcat or WebLogic Server the user.timezone may have to be set explicitly before starting the container.
-Duser.timezone=UTC

SQL Developer Web requires the Database API be enabled.

SQL Developer Web's DBMS_SCHEDULER interface requires database version 12.2 or higher.

Metadata Catalog

The default output for openapi-catalog is Swagger V2. In a future release the default output will be OpenAPI V3.

Upgrading ORDS in the database

If you have previously executed script, ords_installer_privileges.sql, to grant your administrator user privileges to perform the install or upgrade, then you must execute the script again on that same user that you provided because additional grants have been added to this script. Note: This script does not apply to the SYS user account.

Supported Java Version

Oracle REST Data Services requires Java 11 or 17. Java 8 is no longer supported. Please consult the documentation for the minimum supported Application Server versions for ORDS.

Changes in 22.4.0

The following changes have been made since 22.3.3:

Issues Fixed in 22.4.0

New Features in 22.4.0

Changes in 22.3.3

The following changes have been made since 22.3.2:

Issues Fixed in 22.3.3

New Features in 22.3.3

Changes in 22.3.2

The following changes have been made since 22.3.1:

Issues Fixed in 22.3.2

Changes in 22.3.1

The following changes have been made since 22.3.0:

Issues Fixed in 22.3.1

Changes in 22.3.0

The following changes have been made since 22.2.2:

Issues Fixed in 22.3.0

New Features in 22.3.0

Changes in 22.2.2

The following changes have been made since 22.2.1:

Issues Fixed in 22.2.2

Changes in 22.2.1

The following changes have been made since 22.2.0:

Issues Fixed in 22.2.1

New Features in 22.2.1

Changes in 22.2.0

The following changes have been made since 22.1.1:

Issues Fixed in 22.2.0

New Features in 22.2.0

Changes in 22.1.1

The following changes have been made since 22.1.0:

Issues Fixed in 22.1.1

New Features in 22.1.1

Changes in 22.1.0

The following changes have been made since 21.4.3:

Issues Fixed in 22.1.0

New Features in 22.1.0

Changes in 21.4.3

The following changes have been made since 21.4.2:

Issues Fixed in 21.4.3

Changes in 21.4.2

The following changes have been made since 21.4.1:

Issues Fixed in 21.4.2

New Features in 21.4.2

Changes in 21.4.1

The following changes have been made since 21.4.0:

Issues Fixed in 21.4.1

Changes in 21.4.0

The following changes have been made since 21.3.2:

Issues Fixed in 21.4.0

New Features in 21.4.0

Changes in 21.3.2

The following changes have been made since 21.3.1:

Issues Fixed in 21.3.2

Changes in 21.3.1

The following changes have been made since 21.3.0:

Issues Fixed in 21.3.1

New Features in 21.3.1

Changes in 21.3.0

The following changes have been made since 21.2.4:

Issues Fixed in 21.3.0

New Features in 21.3.0

Changes in 21.2.4

The following changes have been made since 21.2.3:

Issues Fixed in 21.2.4

Changes in 21.2.3

The following changes have been made since 21.2.2:

Issues Fixed in 21.2.3

Changes in 21.2.2

The following changes have been made since 21.2.1:

Issues Fixed in 21.2.2

Changes in 21.2.1

The following changes have been made since 21.2.0:

Issues Fixed in 21.2.1

Changes in 21.2.0

The following changes have been made since 21.1.3:

Issues Fixed in 21.2.0

New Features in 21.2.0

Changes in 21.1.3

The following changes have been made since 21.1.2:

Issues Fixed in 21.1.3

Changes in 21.1.2

The following changes have been made since 21.1.1:

Issues Fixed in 21.1.2

Changes in 21.1.1

The following changes have been made since 21.1.0:

Issues Fixed in 21.1.1

New Features in 21.1.1

Changes in 21.1.0

The following changes have been made since 20.4.3:

Issues Fixed in 21.1.0

New Features in 21.1.0

Changes in 20.4.5

The following changes have been made since 20.4.4:

Issues Fixed in 20.4.5

New Features in 20.4.5

Changes in 20.4.4

The following changes have been made since 20.4.3:

Issues Fixed in 20.4.4

New Features in 20.4.4

Changes in 20.4.3

The following changes have been made since 20.4.2:

Issues Fixed in 20.4.3

New Features in 20.4.3

Changes in 20.4.2

The following changes have been made since 20.4.1:

New Features in 20.4.2

Changes in 20.4.1

The following changes have been made since 20.3.1:

Issues Fixed in 20.4.1

New Features in 20.4.1

Changes in 20.3.1

The following changes have been made since 20.3.0:

Issues Fixed in 20.3.1

Changes in 20.3.0

The following changes have been made since 20.2.3:

Issues Fixed in 20.3.0

New Features in 20.3.0

Changes in 20.2.3

The following changes have been made since 20.2.2:

New Features in 20.2.3

Changes in 20.2.2

The following changes have been made since 20.2.0:

Issues Fixed in 20.2.2

Changes in 20.2.0

The following changes and enhancements have been made since 20.1.0:

Issues Fixed in 20.2.0

New Features in 20.2.0

Changes in 20.1.0

The following changes and enhancements have been made since 19.4.5:

Issues Fixed in 20.1.0

New Features in 20.1.0

Changes in 19.4.6

The following changes and enhancements have been made since 19.4.0:

Issues Fixed in 19.4.6

New Features in 19.4.6

Changes in 19.4.0

The following changes and enhancements have been made since 19.3.0:

Issues Fixed in 19.4.0

New Features in 19.4.0

Changes in 19.3.0

The following changes and enhancements have been made since 19.2.0

Issues Fixed in 19.3.0

New Features in 19.3.0

Changes in 19.2.0

The following changes and enhancements have been made since 19.1.0:

Issues Fixed in 19.2.0

New Features in 19.2.0

Changes in 19.1.0

The following changes and enhancements have been made since 18.4.0:

Issues Fixed in 19.1.0

New Features in 19.1.0

Changes in 18.4.0

The following changes and enhancements have been made since 18.3.0:

Issues Fixed in 18.4.0

New Features in 18.4.0

Earlier versions

For information on Issues Fixed and New Features introduced for earlier versions please refer to the release notes for those versions.

Known Issues

Oracle Database may report 'ORA-01031: insufficient privileges' for queries that involve CURSOR expressions

In a number of cases, ORDS executes queries which include a CURSOR expression. An issue has been found executing these queries for some schemas in Oracle 18c and Oracle 19c databases. Depending on the roles and privileges involved, the issue does not occur for all schemas, which can give the impression that the issue is intermittent. Refer to RDBMS bug 29049673 for more information. The issue is manifest as follows in the exception returned:

ORA-00604: error occurred at recursive SQL level 1

ORA-01031: insufficient privileges

This is a problem with view-merging of nested cursors introduced in Oracle 18.1 database. Please use the following as a workaround:

alter system set "_fix_control"='20648883:OFF';

Oracle Database DATE and TIMESTAMP values

ORDS interprets Oracle Database DATE and TIMESTAMP values (which do not possess a time zone) into the time zone of ORDS. These values are then represented in the RFC3339 UTC format.

In a future release Oracle Database DATE and TIMESTAMP values will not by default be interpreted into any time zone. These values will be represented in the ISO 8601 "yyyy-mm-ddThh:mm:ss[.sss]" format. Oracle Database TIMESTAMP WITH TIME ZONE and TIMESTAMP WITH LOCAL TIME ZONE values will remain represented in the RFC3339 UTC format.

SQL Developer Web

JDBC Array values

ORDS passes array values to the Oracle Database in a number of cases, for example arrays are used to pass the request headers and form fields during PL/SQL Gateway calls. Oracle JDBC Driver 18.3 and later supports an improved mechanism for passing array values, however this feature is only supported on Oracle Database 12c and later. Thus ORDS uses existing deprecated and less efficient APIs for passing array values when connecting to 11G databases, and the improved mechanism when connected to 12c and later. Customers experiencing problems with passing large array sets (for example OutOfMemory exceptions) are encouraged to upgrade from 11G to a newer database version to mitigate these issues.

Autogenerated REST Endpoints

RESTful Services

Support For mod_plsql logmeoff