Skip to main content

Oracle Database Component

Query and manage data in an OracleDB database

Component key: oracledb ·
· Changelog ↓

Description​

Oracle Database is a popular relational database system. This component allows querying an Oracle database.

API Documentation​

This component was built using Node.js for Oracle Database.

Query formatting​

Instead of generating dynamic queries and sanitizing SQL manually, use generic queries with variable binding. Formatted queries use :variable_name syntax as placeholders for variable values.

For example, the query may read INSERT INTO people (id, first, last) VALUES (:id, :firstname, :lastname) or SELECT firstname, lastname FROM people WHERE id = :id. If the named parameter names are known ahead of time, provide a Named Parameter input with key id, firstname or lastname, and a value that references a previous step's result.

When dynamically generating SQL queries without knowing what parameters are needed ahead of time, create a key/value object in another step and reference them through the Named Parameters Object input. In the example above, generate an object of the form {id: 1, firstname: "John", lastname: "Doe"}.

Connections​

OracleDB Connection​

key: oracledbConnection

OracleDB requires a direct database connection with host, port, and database credentials.

Prerequisites​

  • An Oracle Database instance accessible from the network
  • Database user credentials with appropriate permissions

Configure the Connection​

  • Host: Enter the hostname or IP address of the Oracle DB server (e.g., 192.168.0.1)
  • Port: Enter the port number (default: 1521)
  • Database: Enter the Oracle database SID (e.g., xe)
  • Username: Enter the database username (optional if using OS authentication)
  • Password: Enter the database password (optional if using OS authentication)

On-prem enabled: this connection can be configured to connect to an on-prem resource on a private network. Learn more.

InputNotesExample
Database

The database SID in Oracle DB

xe
Host

Provide the string value for the host of the server.

192.168.0.1
Password
Port

The port of the Oracle DB server.

1521
Connection Timeout

The amount of time (in seconds) to wait for a connection to be established before timing out. Default is 10 seconds.

10
Username

Actions​

Query​

Returns the results of an OracleDB database query | key: query

InputNotesExample
Connection
Named Parameters

Optional named parameters to insert into a query. Ensure the keys of these parameters match parameters in your query. For example, if your query contains ':company_name', give this parameter the key 'company_name'. Values specified here are merged with values supplied from the 'Named Parameters Object' input.

Named Parameters Object

Optional named parameters to insert into a query. Ensure the keys of these parameters match parameters in your query. For example, if your query contains ':company_name', your object should contain a key 'company_name'. Values in this object are merged with values supplied from the 'Named Parameters' input.

SQL Query

{
  "data": [
    {
      "EMPLOYEE_ID": 101,
      "FIRST_NAME": "Alice",
      "LAST_NAME": "Johnson",
      "EMAIL": "AJOHNSON",
      "HIRE_DATE": "2023-03-15T00:00:00.000Z",
      "DEPARTMENT_ID": 60
    },
    {
      "EMPLOYEE_ID": 102,
      "FIRST_NAME": "Bob",
      "LAST_NAME": "Martinez",
      "EMAIL": "BMARTINEZ",
      "HIRE_DATE": "2024-01-10T00:00:00.000Z",
      "DEPARTMENT_ID": 90
    }
  ]
}

Changelog​

2026-04-13​

  • Updated Example Payloads

2026-04-07​

Various modernizations and documentation updates

2025-04-16​

Initial release of Oracle Database component for database connectivity and operations