July 30, 2023

tOracleConfiguration – Docs for ESB 7.x

tOracleConfiguration

Stores connection information and credentials to be reused by other Oracle
components.

You configure the connection to a Oracle database in tOracleConfiguration and configure the other
Oracle components to reuse this configuration. At runtime, the Spark
executors read this configuration in order to connect to Oracle.

Depending on the Talend
product you are using, this component can be used in one, some or all of the following
Job frameworks:

tOracleConfiguration properties for Apache Spark Batch

These properties are used to configure tOracleConfiguration running in the Spark Batch Job framework.

The Spark Batch
tOracleConfiguration component belongs to the Storage and the Databases families.

The component in this framework is available in all subscription-based Talend products with Big Data
and Talend Data Fabric.

Basic settings

Property type

Either Built-In or Repository.

Built-In: No property data stored centrally.

Repository: Select the repository file where the
properties are stored.

Connection type

The available drivers are:

  • Oracle OCI: Select this connection type
    to use Oracle Call Interface with a set of C-language software APIs that provide
    an interface to the Oracle database.

  • Oracle Custom: Select this connection
    type to access a clustered database. With this type of connection, the
    Username and the Password fields are deactivated and you need to
    enter the connection URL in the URL field
    that is displayed.

    For further information about the valid form of this URL, see JDBC Connection
    strings
    from the Oracle documentation.

  • Oracle Service Name: Select this
    connection type to use the TNS alias that you give when you connect to the
    remote database.

  • WALLET: Select this connection type to
    store credentials in an Oracle wallet.

  • Oracle SID: Select this connection type
    to uniquely identify a particular database on a system.

DB Version

Select the version of the Oracle database to be used.

Use tns file

Select this check box to use the metadata of a context included in a tns
file.

Note that one tns file may have many contexts.

TNS File: Enter the path to the tns file manually or
browse to the file by clicking the […] button next
to the field.

Select a DB Connection in Tns File: Click the
[…] button to display all the contexts held in
the tns file and select the desired one.

Host

Enter the IP address of the database server.

Port

Enter the listening port number of the database server.

Database

Enter the name of the database to be used.

Schema

Enter the name of the schema.

Username and Password

Enter the user authentication data.

To enter the password, click the […] button next to the
password field, and then in the pop-up dialog box enter the password between double quotes
and click OK to save the settings.

Additional JDBC parameters

Specify additional connection properties for the database connection you are
creating. The properties are separated by semicolon and each property is a key-value
pair, for example, encryption=1;clientname=Talend.

This field is not available if the Use an existing
connection
check box is selected.

Advanced settings

connection pool

In this area, you configure, for each Spark executor, the connection pool used to control
the number of connections that stay open simultaneously. The default values given to the
following connection pool parameters are good enough for most use cases.

  • Max total number of connections: enter the maximum number
    of connections (idle or active) that are allowed to stay open simultaneously.

    The default number is 8. If you enter -1, you allow unlimited number of open connections at the same
    time.

  • Max waiting time (ms): enter the maximum amount of time
    at the end of which the response to a demand for using a connection should be returned by
    the connection pool. By default, it is -1, that is to say, infinite.

  • Min number of idle connections: enter the minimum number
    of idle connections (connections not used) maintained in the connection pool.

  • Max number of idle connections: enter the maximum number
    of idle connections (connections not used) maintained in the connection pool.

Evict connections

Select this check box to define criteria to destroy connections in the connection pool. The
following fields are displayed once you have selected it.

  • Time between two eviction runs: enter the time interval
    (in milliseconds) at the end of which the component checks the status of the connections and
    destroys the idle ones.

  • Min idle time for a connection to be eligible to
    eviction
    : enter the time interval (in milliseconds) at the end of which the idle
    connections are destroyed.

  • Soft min idle time for a connection to be eligible to
    eviction
    : this parameter works the same way as Min idle
    time for a connection to be eligible to eviction
    but it keeps the minimum number
    of idle connections, the number you define in the Min number of idle
    connections
    field.

Usage

Usage rule

This component is used with no need to be connected to other
components.

The configuration in a tOracleConfiguration component applies only on the Oracle related
components in the same Job. In other words, the Oracle components used in a child or a
parent Job that is called via tRunJob cannot reuse
this configuration.

This component, along with the Spark Batch component Palette it belongs to,
appears only when you are creating a Spark Batch Job.

Note that in this documentation, unless otherwise explicitly stated, a
scenario presents only Standard Jobs, that is to
say traditional
Talend
data integration Jobs.

Spark Connection

In the Spark
Configuration
tab in the Run
view, define the connection to a given Spark cluster for the whole Job. In
addition, since the Job expects its dependent jar files for execution, you must
specify the directory in the file system to which these jar files are
transferred so that Spark can access these files:

  • Yarn mode (Yarn client or Yarn cluster):

    • When using Google Dataproc, specify a bucket in the
      Google Storage staging bucket
      field in the Spark configuration
      tab.

    • When using HDInsight, specify the blob to be used for Job
      deployment in the Windows Azure Storage
      configuration
      area in the Spark
      configuration
      tab.

    • When using Altus, specify the S3 bucket or the Azure
      Data Lake Storage for Job deployment in the Spark
      configuration
      tab.
    • When using Qubole, add a
      tS3Configuration to your Job to write
      your actual business data in the S3 system with Qubole. Without
      tS3Configuration, this business data is
      written in the Qubole HDFS system and destroyed once you shut
      down your cluster.
    • When using on-premise
      distributions, use the configuration component corresponding
      to the file system your cluster is using. Typically, this
      system is HDFS and so use tHDFSConfiguration.

  • Standalone mode: use the
    configuration component corresponding to the file system your cluster is
    using, such as tHDFSConfiguration or
    tS3Configuration.

    If you are using Databricks without any configuration component present
    in your Job, your business data is written directly in DBFS (Databricks
    Filesystem).

This connection is effective on a per-Job basis.

Related scenarios

For a scenario about how to use the same type of component in a Spark Batch Job, see Writing and reading data from MongoDB using a Spark Batch Job.

tOracleConfiguration properties for Apache Spark Streaming

These properties are used to configure tOracleConfiguration running in the Spark Streaming Job framework.

The Spark Streaming
tOracleConfiguration component belongs to the Storage and the Databases families.

This component is available in Talend Real Time Big Data Platform and Talend Data Fabric.

Basic settings

Property type

Either Built-In or Repository.

Built-In: No property data stored centrally.

Repository: Select the repository file where the
properties are stored.

Connection type

The available drivers are:

  • Oracle OCI: Select this connection type
    to use Oracle Call Interface with a set of C-language software APIs that provide
    an interface to the Oracle database.

  • Oracle Custom: Select this connection
    type to access a clustered database. With this type of connection, the
    Username and the Password fields are deactivated and you need to
    enter the connection URL in the URL field
    that is displayed.

    For further information about the valid form of this URL, see JDBC Connection
    strings
    from the Oracle documentation.

  • Oracle Service Name: Select this
    connection type to use the TNS alias that you give when you connect to the
    remote database.

  • WALLET: Select this connection type to
    store credentials in an Oracle wallet.

  • Oracle SID: Select this connection type
    to uniquely identify a particular database on a system.

DB Version

Select the version of the Oracle database to be used.

Use tns file

Select this check box to use the metadata of a context included in a tns
file.

Note that one tns file may have many contexts.

TNS File: Enter the path to the tns file manually or
browse to the file by clicking the […] button next
to the field.

Select a DB Connection in Tns File: Click the
[…] button to display all the contexts held in
the tns file and select the desired one.

Host

Enter the IP address of the database server.

Port

Enter the listening port number of the database server.

Database

Enter the name of the database to be used.

Schema

Enter the name of the schema.

Username and Password

Enter the user authentication data.

To enter the password, click the […] button next to the
password field, and then in the pop-up dialog box enter the password between double quotes
and click OK to save the settings.

Additional JDBC parameters

Specify additional connection properties for the database connection you are
creating. The properties are separated by semicolon and each property is a key-value
pair, for example, encryption=1;clientname=Talend.

This field is not available if the Use an existing
connection
check box is selected.

Advanced settings

connection pool

In this area, you configure, for each Spark executor, the connection pool used to control
the number of connections that stay open simultaneously. The default values given to the
following connection pool parameters are good enough for most use cases.

  • Max total number of connections: enter the maximum number
    of connections (idle or active) that are allowed to stay open simultaneously.

    The default number is 8. If you enter -1, you allow unlimited number of open connections at the same
    time.

  • Max waiting time (ms): enter the maximum amount of time
    at the end of which the response to a demand for using a connection should be returned by
    the connection pool. By default, it is -1, that is to say, infinite.

  • Min number of idle connections: enter the minimum number
    of idle connections (connections not used) maintained in the connection pool.

  • Max number of idle connections: enter the maximum number
    of idle connections (connections not used) maintained in the connection pool.

Evict connections

Select this check box to define criteria to destroy connections in the connection pool. The
following fields are displayed once you have selected it.

  • Time between two eviction runs: enter the time interval
    (in milliseconds) at the end of which the component checks the status of the connections and
    destroys the idle ones.

  • Min idle time for a connection to be eligible to
    eviction
    : enter the time interval (in milliseconds) at the end of which the idle
    connections are destroyed.

  • Soft min idle time for a connection to be eligible to
    eviction
    : this parameter works the same way as Min idle
    time for a connection to be eligible to eviction
    but it keeps the minimum number
    of idle connections, the number you define in the Min number of idle
    connections
    field.

Usage

Usage rule

This component is used with no need to be connected to other components.

The configuration in a tOracleConfiguration component applies only on the Oracle related
components in the same Job. In other words, the Oracle components used in a child or a
parent Job that is called via tRunJob cannot reuse
this configuration.

This component, along with the Spark Streaming component Palette it belongs to, appears
only when you are creating a Spark Streaming Job.

Note that in this documentation, unless otherwise explicitly stated, a scenario presents
only Standard Jobs, that is to say traditional
Talend
data
integration Jobs.

Spark Connection

In the Spark
Configuration
tab in the Run
view, define the connection to a given Spark cluster for the whole Job. In
addition, since the Job expects its dependent jar files for execution, you must
specify the directory in the file system to which these jar files are
transferred so that Spark can access these files:

  • Yarn mode (Yarn client or Yarn cluster):

    • When using Google Dataproc, specify a bucket in the
      Google Storage staging bucket
      field in the Spark configuration
      tab.

    • When using HDInsight, specify the blob to be used for Job
      deployment in the Windows Azure Storage
      configuration
      area in the Spark
      configuration
      tab.

    • When using Altus, specify the S3 bucket or the Azure
      Data Lake Storage for Job deployment in the Spark
      configuration
      tab.
    • When using Qubole, add a
      tS3Configuration to your Job to write
      your actual business data in the S3 system with Qubole. Without
      tS3Configuration, this business data is
      written in the Qubole HDFS system and destroyed once you shut
      down your cluster.
    • When using on-premise
      distributions, use the configuration component corresponding
      to the file system your cluster is using. Typically, this
      system is HDFS and so use tHDFSConfiguration.

  • Standalone mode: use the
    configuration component corresponding to the file system your cluster is
    using, such as tHDFSConfiguration or
    tS3Configuration.

    If you are using Databricks without any configuration component present
    in your Job, your business data is written directly in DBFS (Databricks
    Filesystem).

This connection is effective on a per-Job basis.

Related scenarios

For a scenario about how to use the same type of component in a Spark Streaming Job, see
Reading and writing data in MongoDB using a Spark Streaming Job.


Document get from Talend https://help.talend.com
Thank you for watching.
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x