Skip to main content
oracledb icon

Oracle Database Connector

SourceOracleDB DocsNode.js Client DocsConnector 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

On-Premise Connection

key: oracledbConnection

Create a connection of type On-Premise Connection to authenticate with an Oracle Database server using a direct 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: The hostname or IP address of the Oracle Database server (e.g., 192.168.0.1)
  • Port: The port the database server is exposing (default: 1521)
  • Database: The Oracle database SID to connect to (e.g., xe)
  • Username (optional): The username for authenticating with the Oracle Database server (omit when using OS authentication)
  • Password (optional): The password for authenticating with the Oracle Database server (omit when using OS authentication)
  • Connection Timeout (optional): The amount of time in seconds to wait for a connection to be established before timing out (default: 10)

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

The host name or IP address of the Oracle DB server.

192.168.0.1
Password

The password used to authenticate to the Oracle DB server.

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

The username used to authenticate to the Oracle DB server.

Actions

Query

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

InputNotesExample
Connection

The OracleDB connection to use.

Named Parameters

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

{"product_id":123,"customer_name":"Acme Corp"}
SQL Query

The SQL statement to execute against the database. Use named parameters (e.g. ':name') to safely bind values supplied through the parameter inputs.

SELECT * FROM mytable WHERE name = :name AND company = :company_id
Example Payload for Query
Loading…

Changelog

2026-06-29

Various modernizations and documentation updates

2026-04-30

Updated spectral version

2026-04-07

Various modernizations and documentation updates

2025-04-16

Initial release of Oracle Database component for database connectivity and operations