OracleDB

Native Oracle RMAN integration with block-level incrementals and differentials, point-in-time recovery and RMAN block change tracking, driven entirely from NGBackup jobs.

Capabilities

• Native RMAN integration (mode=rman)
• Block-level incrementals: job level Full runs INCREMENTAL LEVEL 0, Incremental runs LEVEL 1, Differential runs LEVEL 1 CUMULATIVE
• Archived redo logs included with the backup (archivelog=include, the default) or backed up on their own (archivelog=only)
• Point-in-time and SCN recovery

Configure

Add the plugin to a Content on the client you want to protect:

Content {
  Name = "oracledb"
  Include {
    Options { Signature = SHA256 }
    Plugin = "oracle: mode=rman sid=ORCL oracle_home=/u01/app/oracle/product/19c/dbhome_1 auth=os channels=auto archivelog=include bct=auto"
  }
}

All parameters are space-separated key=value pairs. The most used ones:

Parameter	Values	Meaning
mode	rman, dump	rman runs an RMAN backup. When mode is omitted the plugin runs a logical Data Pump / export dump instead, so always set mode=rman for physical backups.
sid	Oracle SID (default *)	Instance to protect.
oracle_home	path (default auto)	ORACLE_HOME of the instance.
unix_user	OS user (default oracle)	Operating-system account the RMAN session runs as.
auth	os (default), pwfile:<path>, walletconn:<alias>	How RMAN connects: OS authentication (/ as sysdba), a password file, or a wallet connect alias.
oracle_user	connect string (default / as sysdba)	Only for database-credential logins: a user/password connect string used instead of OS authentication.
channels	auto or a number	RMAN channel count.
compress	zstd (default), lz4, gzip, rman_basic, rman_medium, rman_high, none	Stream compression, or native RMAN compression levels.
bct	auto, on, off	Block change tracking for fast incrementals.
archivelog	include, exclude, only	Archived redo log handling.
validate_after	yes/no	Run an RMAN validation after the backup.
pdbs, exclude_pdb, exclude_tablespace	lists	Multitenant and tablespace selection.
max_rate	MB/s	RMAN read-rate cap.

There are no user=, password= or rman= parameters: the connection is set with auth= (and, for database credentials, oracle_user=).

Restore

Restore the whole database or recover it to a point in time. At restore time the plugin accepts restore options such as:

action        = pitr          # preview | validate | full | pitr | scn | table | clone | flashback
target_time   = 2026-04-25_15:30:00
preview_first = yes
verify_after  = yes

action=scn with target_scn= recovers to an SCN; action=preview and action=validate check the backup set without touching the database.

See also: Restore, Instant Recovery & V2V.