Oracle ORDS Download 21: How to Install and Use the Latest Version
If you are looking for a way to access and manipulate data in your Oracle Database using RESTful web services, you might want to consider using Oracle REST Data Services (ORDS). ORDS is a Java application that bridges HTTPS and your Oracle Database, providing a Database Management REST API, SQL Developer Web, a PL/SQL Gateway, SODA for REST, and the ability to publish RESTful web services for interacting with the data and stored procedures in your Oracle Database.
In this article, we will show you how to download, install, configure, and use the latest version of ORDS, which is 21.1.1 as of May 2021. We will also discuss some of the benefits, features, and alternatives of ORDS, as well as some best practices and tips for using it effectively.
oracle ords download 21
What is Oracle ORDS?
Oracle REST Data Services (ORDS) is an OASIS standard REST API that was originally developed by Microsoft in 2007. It allows the creation and consumption of queryable and interoperable RESTful APIs in a simple and standard way. ORDS supports both relational and NoSQL databases, such as Oracle Database, Times Ten, and NoSQL.
ORDS is delivered as a Java application (war file) that can run standalone or within a J2EE container (such as Apache Tomcat, GlassFish, or WebLogic). It does not require an Oracle home or any additional software installation. It uses an embedded JDBC driver to connect to the database and universal connection pool (UCP) technology to manage the connection pools.
Benefits of Oracle ORDS
Some of the benefits of using ORDS are:
It provides secure, performant HTTPS access for your Oracle Database, whether it is on-premises or on the cloud.
It simplifies the development and consumption of RESTful web services for your database objects, such as tables, views, packages, procedures, etc.
It enables you to use SQL Developer Web, a web-based version of Oracle SQL Developer that allows you to execute queries and scripts, create and alter database objects, build data models, access Performance Hub, and view database activity.
It supports SODA for REST, a simple and flexible way to store and retrieve JSON documents in your database using REST.
It supports automatic REST enablement of tables and views, which means you can expose them as RESTful web services without writing any code.
It supports OAuth2 authentication and authorization for securing your web services.
It supports various formats for data representation, such as JSON, XML, CSV, etc.
It supports various query options for filtering, sorting, paging, expanding, etc.
It supports various operations for creating, reading, updating, deleting (CRUD) data using HTTP methods such as POST, GET, PUT/PATCH, DELETE.
It supports various features for enhancing the functionality and performance of your web services, such as batch requests, caching, etags, etc.
Features of Oracle ORDS
Some of the features of ORDS are:
Database Management REST API: This is a set of predefined web services that allow you to perform various administrative tasks on your database using REST. For example, you can create users and roles, grant privileges, manage tablesp spaces, monitor sessions, backup and restore data, etc. You can also create your own custom web services using the Database Management REST API.
PL/SQL Gateway: This is a feature that allows you to publish your PL/SQL stored procedures and functions as RESTful web services. You can use annotations or a configuration file to define the web service metadata, such as the URL mapping, parameters, return type, etc. You can also use the ORDS PL/SQL API to programmatically manipulate the web service definitions.
Auto REST: This is a feature that allows you to automatically expose your database tables and views as RESTful web services without writing any code. You can use the ORDS SQL Developer extension or the ORDS REST Data Services API to enable or disable Auto REST for your tables and views. You can also use the ORDS SQL Developer extension or the ORDS PL/SQL API to customize the web service metadata, such as the URL mapping, pagination, filtering, etc.
SQL Developer Web: This is a web-based version of Oracle SQL Developer that allows you to access and manage your database using a browser. You can use SQL Developer Web to execute queries and scripts, create and alter database objects, build data models, access Performance Hub, and view database activity. You can also use SQL Developer Web to enable and disable Auto REST for your tables and views, as well as to test and debug your web services.
SODA for REST: This is a feature that allows you to store and retrieve JSON documents in your database using REST. You can use SODA for REST to create collections of JSON documents, insert, update, delete, and query documents using HTTP methods and JSON payloads, and perform various operations on collections and documents using query parameters. You can also use SODA for REST to access Oracle Database features such as transactions, concurrency control, indexing, etc.
Alternatives to Oracle ORDS
Some of the alternatives to ORDS are:
Oracle Application Express (APEX): This is a low-code development platform that allows you to build data-driven web applications using a browser. APEX includes a RESTful Services module that allows you to create and consume RESTful web services for your database objects. APEX also includes a SQL Workshop module that allows you to access and manage your database using a browser.
Oracle Database Gateway for OData: This is a feature that allows you to expose your database tables and views as OData (Open Data Protocol) web services. OData is a standard protocol for creating and consuming RESTful APIs that support CRUD operations and query options. You can use the Database Gateway for OData to enable or disable OData for your tables and views, as well as to customize the web service metadata.
Oracle Data Provider for .NET (ODP.NET) Managed Driver: This is a feature that allows you to access your database using .NET Framework or .NET Core applications. ODP.NET Managed Driver includes an Entity Framework Core provider that supports code-first and database-first approaches for creating data models and querying data using LINQ (Language Integrated Query). ODP.NET Managed Driver also includes an ASP.NET Core provider that supports creating RESTful web services using Entity Framework Core models.
How to Download Oracle ORDS 21
There are two ways to download Oracle ORDS 21: from the Oracle website or from the yum repository.
Downloading from Oracle Website
To download ORDS from the Oracle website, you need to have an Oracle account. If you don't have one, you can create one for free by following these steps:
Go to .
Click on the Download button under Oracle REST Data Services.
You will be redirected to the Oracle Software Delivery Cloud page.
Click on Sign In/Register button on the top right corner.
Click on Create Account link under New User?
Fill in the required information and click on Create button.
You will receive an email with a verification link. Click on it to activate your account.
Once you have an Oracle account, you can download ORDS by following these steps:
oracle rest data services 21.1 download
how to install oracle ords 21 on tomcat
oracle ords 21 release notes
oracle ords 21 documentation
oracle ords 21 sql developer web
oracle ords 21 performance hub
oracle ords 21 automatic rest
oracle ords 21 pl/sql gateway
oracle ords 21 soda for rest
oracle ords 21 security guide
oracle ords 21 configuration parameters
oracle ords 21 quick start guide
oracle ords 21 deployment options
oracle ords 21 troubleshooting tips
oracle ords 21 upgrade steps
oracle ords 21 new features
oracle ords 21 compatibility matrix
oracle ords 21 license agreement
oracle ords 21 forum support
oracle ords 21 feedback channel
oracle ords 21 installation video tutorial
oracle ords 21 docker image
oracle ords 21 apex integration
oracle ords 21 json support
oracle ords 21 restful web services examples
oracle ords 21 database management rest api
oracle ords 21 multitenant architecture
oracle ords 21 command-line interface
oracle ords 21 logging and auditing
oracle ords 21 caching and pagination
oracle ords 21 authentication and authorization
oracle ords 21 oauth2 client credentials grant type
oracle ords 21 open api specification
oracle ords 21 rest enabled sql service
oracle ords 21 spatial and graph support
oracle ords 21 xml schema validation
oracle ords 21 pdf generation removal
oracle ords 21 date format settings
oracle ords 21 url mapping patterns
oracle ords 21 static files support
oracle ords 21 proxy user connections
oracle ords 21 batch requests and responses
oracle ords 21 media resource type handlers
oracle ords 21 custom error messages
oracle ords 21 cors configuration
oracle ords 21 database cloud service integration
oracle ords 21 autonomous database shared subscribers
oracle ords download previous versions
Go to .
Click on the Download button under Oracle REST Data Services.
You will be redirected to the Oracle Software Delivery Cloud page.
Sign in with your Oracle account credentials.
Select your platform (such as Linux x86- 64) and click on Continue.
Accept the license agreement and click on Continue.
Click on the Download button next to Oracle REST Data Services 21.1.1.
Save the file (ords-21.1.1.zip) to your desired location.
Downloading from yum Repository
If you are using Oracle Linux, you can download ORDS from the yum repository by following these steps:
Enable the Oracle Software Collection Library repository by running the following command as root:
yum-config-manager --enable ol7_oracle_software_collections
Install ORDS by running the following command as root:
yum install ords
The ORDS files will be installed in the /usr/share/ords directory.
How to Install and Configure Oracle ORDS 21
After downloading ORDS, you need to install and configure it before you can use it. The installation and configuration process depends on whether you are using a standalone or a J2EE container mode.
System Requirements
Before installing ORDS, you need to make sure that your system meets the following requirements:
You have a supported Oracle Database version (11g or later) with a valid license.
You have a supported Java version (8 or later) with a valid license.
You have a supported web server or application server (such as Apache Tomcat, GlassFish, or WebLogic) if you are using a J2EE container mode.
You have enough disk space, memory, and CPU resources for your expected workload.
Installer Privileges Script
Before installing ORDS, you need to run a script that grants the necessary privileges to the ORDS installer user. The script is called ords_installer_privileges.sql and it is located in the docs folder of the ORDS zip file. You can run the script by following these steps:
Unzip the ORDS zip file to a temporary location.
Connect to your database as SYSDBA using SQL*Plus or SQL Developer.
Run the script by entering the following command:
@ords_installer_privileges.sql
Enter a username and password for the ORDS installer user when prompted. The default username is ORDS_PUBLIC_USER.
The script will create the ORDS installer user and grant it the necessary privileges.
Interactive Command-Line Interface Installation
If you want to install and configure ORDS using an interactive command-line interface, you can follow these steps:
Unzip the ORDS zip file to your desired location.
Navigate to the ORDS folder using a terminal or a command prompt.
Run the following command:
java -jar ords.war install
The installer will prompt you for various information, such as:
The database connection details (host, port, service name, username, password).
The database schema for storing ORDS metadata (default is ORDS_METADATA).
The database schema for storing RESTful web services (default is ORDS_PUBLIC_USER).
The base path for accessing RESTful web services (default is /ords).
The mode of installation (standalone or J2EE container).
The port number for standalone mode (default is 8080).
The location of APEX images for standalone mode (optional).
The installer will validate your inputs and install and configure ORDS accordingly.
Non-Interactive Command-Line Interface Installation
If you want to install and configure ORDS using a non-interactive command-line interface, you can follow these steps:
Unzip the ORDS zip file to your desired location.
Navigate to the ORDS folder using a terminal or a command prompt.
Create a parameter file that contains the information for installing and configuring ORDS. The parameter file is a text file that has the following format:
db.hostname=host db.port=port db.servicename=service db.username=username db.password=password user.public.password=password user.tablespace.default=tablespace user.tablespace.temp=tablespace rest.services.ords.add=true rest.services.apex.add=false rest.services.soda.add=true schema.tablespace.default=tablespace schema.tablespace.temp=tablespace standalone.mode=true standalone.http.port=port standalone.static.images=/path/to/images
Replace the values with your own database connection details, passwords, tablespaces, etc. You can also change the options for enabling or disabling REST services, choosing the mode of installation, etc.
Save the parameter file as ords_params.properties in the ORDS folder.
Run the following command:
java -jar ords.war install --parameterFile ords_params.properties
The installer will use the information from the parameter file and install and configure ORDS accordingly.
How to Use Oracle ORDS 21
After installing and configuring ORDS, you can start using it to access and manipulate data in your database using RESTful web services. Here are some of the ways you can use ORDS:
Deploying Oracle REST Data Services
If you are using a standalone mode, you can start ORDS by running the following command from the ORDS folder:
java -jar ords.war
This will start a Jetty web server on the port number that you specified during the installation. You can then access ORDS by entering the following URL in your browser:
If you are using a J2EE container mode, you need to deploy the ords.war file to your web server or application server. The exact steps may vary depending on the server that you are using, but generally, you need to copy the ords.war file to the webapps or deployments folder of your server and restart it. You can then access ORDS by entering the following URL in your browser:
Building RESTful Web Services
You can use ORDS to build RESTful web services for your database objects, such as tables, views, packages, procedures, etc. There are two ways to do this: using Auto REST or using PL/SQL Gateway.
Using Auto REST
This is the easiest way to create web services for your tables and views. You just need to enable Auto REST for your tables and views using SQL Developer Web or the ORDS REST Data Services API. For example, you can run the following command in SQL Developer Web to enable Auto REST for a table called EMPLOYEES:
BEGIN ORDS.enable_schema(p_enabled => TRUE); ORDS.enable_object(p_object => 'EMPLOYEES'); END; /
This will create a web service for the EMPLOYEES table with the following URL:
You can then use HTTP methods such as GET, POST, PUT/PATCH, DELETE to perform CRUD operations on the table. For example, you can run the following command in a terminal or a command prompt to retrieve all rows from the EMPLOYEES table:
curl -X GET
You can also use query parameters to filter, sort, page, expand, etc. For example, you can run the following command to retrieve only the first name and last name of employees whose salary is greater than 10000 and sort them by last name in descending order:
curl -X GET
Using PL/SQL Gateway
This is a more advanced way to create web services for your database objects, such as packages, procedures, functions, etc. You need to use annotations or a configuration file to define the web service metadata, such as the URL mapping, parameters, return type, etc. You can also use the ORDS PL/SQL API to programmatically manipulate the web service definitions.
For example, you can create a web service for a procedure called GET_EMPLOYEE that takes an employee ID as an input parameter and returns the employee details as an output parameter. You can use the following annotation in your procedure definition:
--%rest --%description Get employee details by ID --%endpoint /employees/id --%method GET --%source PROCEDURE get_employee ( p_emp_id IN employees.employee_id%TYPE, p_emp_rec OUT employees%ROWTYPE );
This will create a web service for the GET_EMPLOYEE procedure with the following URL:
You can then use HTTP methods such as GET to invoke the procedure. For example, you can run the following command in a terminal or a command prompt to invoke the procedure with an employee ID of 100:
curl -X GET
Using SQL Developer Web
You can use SQL Developer Web to access and manage your database using a browser. You can use SQL Developer Web to execute queries and scripts, create and alter database objects, build data models, access Performance Hub, and view database activity. You can also use SQL Developer Web to enable and disable Auto REST for your tables and views, as well as to test and debug your web services.
To access SQL Developer Web, you need to have an Oracle account with the appropriate privileges. You can create an Oracle account using SQL Developer Web or using SQL*Plus or SQL Developer. For example, you can run the following command in SQL*Plus or SQL Developer to create an Oracle account called scott with the password tiger:
CREATE USER scott IDENTIFIED BY tiger; GRANT CONNECT, RESOURCE TO scott;
Once you have an Oracle account, you can access SQL Developer Web by entering the following URL in your browser:
You will be prompted to enter your Oracle account credentials and then you will see the SQL Developer Web interface.
Using SODA for REST
You can use SODA for REST to store and retrieve JSON documents in your database using REST. You can use SODA for REST to create collections of JSON documents, insert, update, delete, and query documents using HTTP methods and JSON payloads, and perform various operations on collections and documents using query parameters. You can also use SODA for REST to access Oracle Database features such as transactions, concurrency control, indexing, etc.
To use SODA for REST, you need to have an Oracle account with the appropriate privileges. You can create an Oracle account using SQL Developer Web or using SQL*Plus or SQL Developer. For example, you can run the following command in SQL*Plus or SQL Developer to create an Oracle account called soda with the password soda:
CREATE USER soda IDENTIFIED BY soda; GRANT CREATE SESSION TO soda; GRANT SODA_APP TO soda;
Once you have an Oracle account, you can use SODA for REST by entering the following URL in your browser:
You will be prompted to enter your Oracle account credentials and then you will see the SODA for REST interface.
Conclusion
In this article, we have shown you how to download, install, configure, and use Oracle ORDS 21, the latest version of Oracle REST Data Services. We have also discussed some of the benefits, features, and alternatives of ORDS, as well as some best practices and tips for using it effectively.
ORDS is a powerful tool that allows you to access and manipulate data in your Oracle Database using RESTful web services. It provides a Database Management REST API, SQL Developer Web, a PL/SQL Gateway, SODA for REST, and the ability to publish RESTful web services for interacting with the data and stored procedures in your Oracle Database.
We hope that this article has helped you understand how to use ORDS and how it can enhance your database development and administration experience. If you have any questions or feedback, please feel free to contact us or leave a comment below. Thank you for reading and happy coding!
FAQs
Here are some of the frequently asked questions about Oracle ORDS 21:
What are the differences between ORDS 21 and previous versions?
Some of the differences between ORDS 21 and previous versions are:
ORDS 21 supports Oracle Database 21c and Oracle Database Cloud Service.
ORDS 21 supports Java 11 and later versions.
ORDS 21 supports OAuth2 client credentials grant type for securing web services.
ORDS 21 supports JSON Merge Patch for partial updates of JSON documents.
ORDS 21 supports OpenAPI 3.0 specification for documenting web services.
How can I upgrade to ORDS 21 from previous versions?
To upgrade to ORDS 21 from previous versions, you need to follow these steps:
Download ORDS 21 from the Oracle website or the yum repository.
Stop your existing ORDS instance.
Backup your existing ORDS configuration files and database schemas.
Unzip the ORDS 21 zip file to your desired location.
Copy your existing ORDS configuration files to the ORDS 21 folder.
Run the following command from the ORDS 21 folder:
java -jar ords.war validate
This will validate your configuration files and database schemas and upgrade them if necessary.
Start your new ORDS instance by running the following command from the ORDS 21 folder:
java -jar ords.war
If you are using a J2EE container mode, you need to redeploy the ords.war file to your web server or application server.
How can I troubleshoot ORDS issues?
To troubleshoot ORDS issues, you can use the following resources:
The ORDS log files, which are located in the logs folder of the ORDS installation directory. The log files contain information about the requests, responses, errors, warnings, etc. that occur during the ORDS operation.
The ORDS documentation, which is available at . The documentation contains detailed information about the installation, configuration, usage, security, performance, etc. of ORDS.
The ORDS forum, which is available at . The forum is a place where you can ask questions, share experiences, and get answers from other ORDS users and experts.
How can I learn more about ORDS?
To learn more about ORDS, you can use the following resources:
The ORDS blog, which is available at . The blog contains news, updates, tips, tricks, best practices, etc. about ORDS.
The ORDS YouTube channel, which is available at . The channel contains videos, tutorials, demos, webinars, etc. about ORDS.
The ORDS training courses, which are available at . The courses contain online lessons, quizzes, labs, etc. that teach you how to use ORDS effectively.
How can I provide feedback or suggestions for ORDS?
To provide feedback or suggestions for ORDS, you can use the following methods:
The Oracle REST Data Services Feedback page, which is available at . The page allows you to submit your feedback or suggestions directly to the ORDS development team.
The Oracle REST Data Services Idea Lab page, which is available at . The page allows you to submit your ideas for new features or enhancements for ORDS and vote on other users' ideas.
44f88ac181
Comments