Oracle REST Data Services (ORDS) in KeepTool 16 erstellen

Veröffentlicht 18. September 2023

Aktualisiert Oktober 2025

Einführung

In diesem Beitrag zeigen wir Ihnen, wie Sie KeepTool 16 in Verbindung mit Oracle REST Data Services (ORDS) nutzen können. ORDS ermöglicht es Ihnen, Ihre Oracle-Datenbank als RESTful-Webservices verfügbar zu machen.

ORDS verwendet HTTP(S)-Methoden wie GET, POST, PUT, DELETE, um Datenbankoperationen (CRUD – Create, Read, Update, Delete) abzubilden, und gibt die Ergebnisse als formatiertes JSON zurück.
Als Mid-Tier-Java-Anwendung übersetzt ORDS HTTP-Verben (GET, PUT, POST, DELETE etc.) in Datenbanktransaktionen.
ORDS wird häufig im Zusammenhang mit Oracle APEX eingesetzt, um REST-Interfaces bereitzustellen.

ORDS-URL-Struktur

Eine typische ORDS-Endpunkt-URL sieht folgendermaßen aus:

   http(s)://hostname:port/ords/<pldb>/<schema>/module/template/:id

Die Komponenten im Detail:

  • hostname:port – Hostname und Port, auf dem ORDS läuft

  • ords – Kontextpfad

  • <pldb> – Name der Datenbank bzw. des pluggable database (z. B. orcl)

  • <schema> – Schema-Namensmapping (z. B. hr)

  • module – Logische Gruppierung von Templates

  • template – URI-Muster für Ressourcen

  • :id – Pfadparameter (z. B. eine ID)

Jedes Template kann einen oder mehrere Handler besitzen, die definieren, wie Anfragen (GET, POST etc.) behandelt werden.

Installation von ORDS

  • Laden Sie die neueste ORDS-Version von https://download.oracle.com/otn_software/java/ords/ords-latest.zip herunter.

  • Im Installationsverzeichnis finden Sie den params-Ordner mit der Datei ords_params.properties, mit der Sie Konfigurationsparameter vorab setzen können.

  • ORDS kann auf WebLogic, Tomcat oder im Standalone-Modus betrieben werden.

  • In diesem Artikel konzentrieren wir uns auf den Standalone-Modus.

  • Während der Installation werden Sie aufgefordert, einen ORDS-Administrationsbenutzer festzulegen — z. B. PDBADMIN.

  • Außerdem werden zwei neue Schemas geschaffen:

    • ORDS_METADATA

    • ORDS_PUBLIC_USER
      Diese enthalten PL/SQL-Objekte, Views und Tabellen, die die interne Logik von ORDS abbilden.

  • Die ORDS-Dialoge in KeepTool/Hora bauen auf diesen Strukturen auf.


Start des ORDS-Servers (Standalone-Modus unter Windows)

Stellen Sie sicher, dass das Verzeichnis ORDS\bin in Ihrer PATH-Umgebung enthalten ist.
Dann starten Sie den ORDS-Server mit folgendem Befehl:

   ords --config ${ORDS_CONFIG} serve

Der Server läuft daraufhin im Standalone-Modus und wartet auf HTTP/HTTPS-Anfragen.


ORDS für ein Schema aktivieren

In KeepTool (Hora) finden Sie die ORDS-Funktionen unter der Menügruppe „Additional“.
Am unteren Rand der Seite befindet sich das Datenraster ORDS Schema.

  • Wenn Sie ORDS-Administratorrechte besitzen, können Sie per Rechtsklick → „Enable Schema“ ein Schema für ORDS freischalten.

  • Ein Dialog erscheint, in dem Sie das Schema (z. B. HR) und ein URI-Mapping-Muster (Standard: Schemaname in Kleinbuchstaben) festlegen.

  • Nach Bestätigung erscheint das Schema im Raster.

  • Als normaler Benutzer sehen Sie nur Ihr eigenes Schema.

Wenn Sie zu einem anderen Schema navigieren, zeigen alle ORDS-Registerkarten (z. B. Module) die Objekte des ausgewählten Schemas.
Um ORDS-Objekte zu verwalten, empfiehlt sich eine Verbindung mit dem entsprechenden ORDS-fähigen Benutzer.


Modul erstellen

Ein ORDS-Modul ist eine logische Einheit, in der Templates und Handler organisiert werden.
Zum Beispiel könnte man ein Modul namens hr_demo anlegen.

So geht’s in Hora:

  1. Wechseln Sie zur Modules-Registerkarte.

  2. Rechtsklick → „Create module“.

  3. Geben Sie den Modulnamen und den Basis-URI (Prefix) an (mit führendem und abschließendem Slash).

  4. Bestätigen Sie die Eingabe.

Das Modul erscheint danach in der Tabellendarstellung und beispielhafte URIs für HTTP/HTTPS werden angezeigt.


Template erstellen

In der Templates-Registerkarte:

  1. Rechtsklick → „Create template“.

  2. Wählen Sie das Modul (z. B. hr_demo) aus.

  3. Geben Sie ein URI-Muster ein (z. B. emp für Employees).

  4. Optional: Kommentar ergänzen.

  5. Bestätigen Sie den Dialog.

Das neue Template erscheint in der Tabellendarstellung und unterhalb werden automatisch Beispiel-URIs für HTTP/HTTPS angezeigt.

Beachten Sie: Ein funktionierender Webservice benötigt Modul + Template + mindestens einen Handler.


Handler definieren (die REST-Logik)

Ein Template benötigt Handler, um Anfragen zu verarbeiten.

  • Wechseln Sie zur Handlers-Registerkarte.

  • Rechtsklick → „Create handler“.

  • Wählen Sie das Template (z. B. /emp).

  • Wählen Sie die HTTP-Methode (z. B. GET).

  • Wählen Sie das Format (z. B. JSON).

  • Geben Sie im Editor Ihre SQL- oder PL/SQL-Logik ein:

Definieren Sie Bind-Parameter (z. B. id und sal) im Parameterbereich unterhalb des SQL-Editors:

Hora generiert automatisch Beispiel-URIs für Tests, z. B.:

   https://localhost:8443/ords/hr/hr_demo/emp/123
   https://localhost:8443/ords/hr/hr_demo/emp/?sal=10


Test des Datenservices

Lassen Sie ORDS laufen und:

  1. Kopieren Sie einen der in Hora angezeigten URIs.

  2. Öffnen Sie diesen URI in einem Browser oder REST-Client (z. B. Postman).

  3. Die Antwort sollte JSON-Daten der Tabelle EMPLOYEES enthalten.

Beispiel mit Parametern:

  • ?id=123 oder

  • ?sal=10000

 

So können Sie Ergebnisse dynamisch filtern.

 

Das JSON entspricht der Handler-Logik und berücksichtigt die angegebenen Parameter.


Erweiterung Ihrer ORDS-Services

Mit den Grundlagen können Sie weitergehen:

  • POST, PUT, DELETE Handler hinzufügen

  • Verschachtelte JSON-Strukturen oder Arrays zurückgeben

  • Authentifizierungs- und Autorisierungsschemata integrieren

  • ORDS-Endpoints in APEX oder andere Webanwendungen einbinden

ORDS bietet eine vollwertige Web-Schicht für Oracle-Datenbanken, und KeepTool ermöglicht Ihnen, diese Dienste einfach und visuell zu verwalten.


Zusammenfassung

Mit KeepTool 16 und Oracle REST Data Services können Sie:

  1. ORDS für ein Schema aktivieren

  2. REST-Module, Templates und Handler erstellen

  3. SQL-basierte REST-Endpunkte in Minuten definieren

  4. Ihre APIs direkt aus Hora testen

Dieses Vorgehen ermöglicht Entwicklern, DBA und Analysten, moderne REST-Dienste aus bestehenden Oracle-Daten schnell und effizient zu erstellen — ganz ohne aufwändige manuelle PL/SQL-Codierung.


➡️ KeepTool kostenlos testen

Die Oracle-Tools von KeepTool wurden speziell für Entwickler, DBAs und Support-Teams entwickelt.
Basierend auf über 25 Jahren Erfahrung optimieren wir unsere Software kontinuierlich, um Ihre Datenbankanalyse und -dokumentation schneller, effizienter und übersichtlicher zu gestalten.