This topic describes how to link to a single instance Oracle database using the Delphix Engine command line interface.


You will need the following information:

  • The name of the dSource you want to create.
  • The group in which you want to create the dSource.
  • The database unique name of the Oracle database you want to link to.
  • The database username/password with sufficient privileges as described in the Delphix User Guide.
  • The host environment user with sufficient privileges as described in the Delphix User Guide.


  1. Execute the database link command.

    delphix> database link
    delphix database link>
  2. The default link operation is OracleLinkParameters, but you can confirm that by getting the input type:

    delphix database link *> get type 
  3. Set the name for the dSource and the group in which you want to create it.

    delphix database link *> set
    delphix database link *> set"<New Group>"
  4. Set the source configuration.
    For Oracle databases, these are identified by the database unique name. If you are unsure of the set of available databases, you can list available source configurations.

    delphix database link *> /sourceconfig list
    example1  '/opt/ora/dexample1'  true
    example2  '/opt/ora/dexample1'  true
    delphix database link *> set source.config=example1
  5. Set the privileged database username/password.
    The password can be set like other properties, or the value can be omitted so that it can be manually input without exposing the password.

    delphix database link *> set dbUser=delphix
    delphix database link *> set dbCredentials.password
    Enter dbCredentials.password: ********
  6. Set the privileged environment user.
    This user must be from the same environment as the associated source config set in step 4. You can list the set of available users through the environment user listcommand.

    delphix database link *> /environment/user list
    delphix database link *> set environmentUser=
  7. Adjust any other properties you may want, such as RMAN tunables, description, and whether to link now.
    The full set of options is described in the API documentation for the OracleLinkParameters type. If you set the linkNowproperty, then this operation will wait for the sync to complete, otherwise you can perform the initial link by running the sync command at a later point.

    delphix database link *> set masked=true
  8. Commit the result.

    delphix database link *> commit