tPostgresqlOutput
Executes the action defined on the table and/or on the data contained in the table, based on the flow incoming from the preceding component in the job.
The tPostgresqlOutput writes, updates, makes changes or suppresses entries in a database.
tPostgresqlOutput Standard properties
These properties are used to configure tPostgresqlOutput running in the Standard Job framework.
The Standard tPostgresqlOutput component belongs to the Databases family.
The component in this framework is available in all Talend products.
Basic settings
| Properties | Description |
|---|---|
| Database |
Select the desired database type from the list and click Apply. |
| Property type |
Either Built-in or Repository .
|
|
|
Click this icon to open a database connection wizard and store the database connection parameters you set in the component Basic settings view. For more information about setting up and storing database connection parameters, see Centralizing database metadata. |
| Use an existing connection |
|
| Host | Enter the database server IP address. |
| Port | Listening port number of DB server. |
| Database | Enter the name of the database. |
| Schema | Enter the name of the PostgreSQL schema. |
| Username and Password | Enter the database user authentication data. To enter the password, click the [...] button next to the password field, enter the password in double quotes in the pop-up dialog box, and click OK to save the settings. |
| Table |
Enter the name of the table to be written. Note that only one table can be written at a time |
| Action on table | Select the operation you want to perform on the defined table: None: No operation is carried out. Drop and create table: The table is removed and created again. Create table: The table does not exist and gets created. Create table if not exists: The table is created if it does not exist. Drop table if exists and create: The table is removed if already exists and created again. Clear table: The table content is deleted. Truncate table: The table content is deleted. You don not have the possibility to rollback the operation. |
| Action on data | Select the operation you want to perform on the data of the defined table: Insert: Add new entries to the table. If duplicates are found, the Job stops.
Update: Make
changes to existing
entries.
Information noteNote: In cases where all the schema
columns are set as keys, this action yields an error and the Job fails.
Insert or
update: Insert a new record. If the record with the given reference
already exists, an update would be
made.
Information noteNote: In cases where all the schema
columns are set as keys, this action yields a warning message and the Job
continues.
Update or
insert: Update the record with the given reference. If the record does
not exist, a new record would be
inserted.
Information noteNote: In cases where all the schema
columns are set as keys, this action yields a warning message and the Job
continues.
Upsert: Insert a record or update an existing record
using the PostgreSQL INSERT-ON CONFLICT statement. This option
is available when you select v9 and later from the
DB Version dropdown list. See PostgreSQL Upsert Using INSERT ON CONFLICT statement
for related information.
Information noteNote:
Delete: Remove entries corresponding to the input flow. Information noteWarning: It is necessary to
specify at least one column as a primary key on which the Update and Delete operations are based. You can do that by clicking
Edit Schema and selecting the
checkbox(es) next to the column(s) you want to set as primary key(s). For an
advanced use, click the Advanced
settings view where you can simultaneously define primary keys
for the Update and Delete operations. To do that: Select the
Use field options check box and then
in the Key in update column, select the
check boxes next to the column names you want to use as a base for the Update
operation. Do the same in the Key in delete
column for the Delete operation.
Information noteNote: The dynamic schema feature can be used
in these modes: Insert; Update; Insert or
update; Update or insert;
Delete.
|
| Schema and Edit Schema |
A schema is a row description. It defines the number of fields (columns) to be processed and passed on to the next component. When you create a Spark Job, avoid the reserved word line when naming the fields. Click Edit schema to make changes to the schema. If the current schema is of the Repository type, three options are available:
This component offers the advantage of the dynamic schema feature. This allows you to retrieve unknown columns from source files or to copy batches of columns from a source without mapping each column individually. For further information about dynamic schemas, see Dynamic schema. This dynamic schema feature is designed for the purpose of retrieving unknown columns of a table and is recommended to be used for this purpose only; it is not recommended for the use of creating tables. Built-In: You create and store the schema locally for this component only. Repository: You have already created the schema and stored it in the Repository. You can reuse it in various projects and Job designs. When the schema to be reused has default values that are integers or functions, ensure that these default values are not enclosed within quotation marks. If they are, you must remove the quotation marks manually. For more information, see Retrieving table schemas. This component supports PostgreSQL vector data types. Use the VECTOR or Dynamic DB type in your schema column definition to store and then query vector embeddings. For more information about pgvector, read the Amazon documentation. |
| Use spatial options |
Select this checkbox to use the PostgreSQL database as a spatial database for geographic information system (GIS). When this checkbox is selected, two other check boxes are displayed:
For more information about the PostgreSQL database, see http://www.postgresql.org/about/. Information noteNote: This check box is available when you selected the table
creation related option from the Action on
table list.
Information noteNote: This check box will disappear if you select the
Enable parallel execution check box
in the Advanced settings view.
|
| Specify a data source alias |
Select this checkbox and specify the alias of a data source created on the Talend Runtime side to use the shared connection pool defined in the data source configuration. This option works only when you deploy and run your Job in Talend Runtime . This checkbox is not available when the Use an existing connection checkbox is selected. |
| Data source alias |
Enter the alias of the data source created on the Talend Runtime side. This field is available only when the Specify a data source alias checkbox is selected. |
| Die on error | This checkbox is cleared by default, meaning to skip the row on error and to complete the process for error-free rows. |
Advanced settings
| Properties | Description |
|---|---|
| Use alternate schema |
Select this option to use a schema other than the one specified by the component that establishes the database connection (that is, the component selected from the Component list drop-down list in Basic settings view). After selecting this option, provide the name of the desired schema in the Schema field. This option is available when Use an existing connection is selected in Basic settings view. |
| Additional JDBC Parameters | Specify additional JDBC parameters for the database connection created. This property is not available when the Use an existing connection check box in the Basic settings view is selected. |
| Commit every | Enter the number of rows to be completed before committing batches of rows together into the DB. This option ensures transaction quality (but not rollback) and, above all, better performance at execution. |
| Additional Columns | This option is not offered if you create (with or without drop) the DB
table. This option allows you to call SQL functions to perform actions on columns,
which are not insert, nor update or delete actions, or action that require
particular preprocessing.
|
| Use save point |
Select this checkbox to use savepoints in the transaction. This
checkbox will not be available if you select:
This checkbox will not work if you:
|
| Use field options | Select this checkbox to customize a request, especially when there is double action on data. |
| Debug query mode |
Select this check box to display each step during processing entries in a database. |
| Support null in "SQL WHERE" statement | Select this checkbox if you want to deal with the Null values contained in a
DB table. Information noteNote: Ensure that the Nullable check box is selected
for the corresponding columns in the schema.
|
| Convert columns and table to lowercase |
Select this checkbox to automatically convert the letters in all the column names and the table name to lowercase when you manipulate a table (such as inserting, deleting, or updating a table). |
| Use Batch |
Select this check box to activate the batch mode for data processing. Information noteNote: This check box is available
only when you have selected the Insert, the Update or the Delete option in the
Action on
data field.
|
| Batch Size |
Specify the number of records to be processed in each batch. This field is available only when the Use batch mode check box is selected. |
| tStat Catcher Statistics | Select this checkbox to collect log data at the component level. |
| Enable parallel execution |
Select this check box to perform high-speed data processing, by treating
multiple data flows simultaneously. Note that this feature depends on the database or
the application ability to handle multiple inserts in parallel as well as the number of
CPU affected. In the Number of parallel executions
field, either:
|
Global Variables
| Variables | Description |
|---|---|
| Global Variables |
NB_LINE: the number of rows processed. This is an After variable and it returns an integer. NB_LINE_UPDATED: the number of rows updated. This is an After variable and it returns an integer. NB_LINE_INSERTED: the number of rows inserted. This is an After variable and it returns an integer. NB_LINE_DELETED: the number of rows deleted. This is an After variable and it returns an integer. NB_LINE_REJECTED: the number of rows rejected. This is an After variable and it returns an integer. QUERY: the query statement processed. This is an After variable and it returns a string. ERROR_MESSAGE: the error message generated by the component when an error occurs. This is an After variable and it returns a string. This variable functions only if the Die on error checkbox is cleared, if the component has this checkbox. A Flow variable functions during the execution of a component while an After variable functions after the execution of the component. To fill up a field or expression with a variable, press Ctrl+Space to access the variable list and choose the variable to use from it. For more information about variables, see Using contexts and variables. |
Usage
| Usage guidance | Description |
|---|---|
| Usage rule | This component offers the flexibility benefit of the DB query and covers all
of the SQL queries possible. This component must be used as an output component. It allows you to carry out actions on a table or on the data of a table in a PostgreSQL database. It also allows you to create a reject flow using a Row > Rejects link to filter data in error. For an example of tMysqlOutput in use, see Retrieving data in error with a Reject link. This component supports PostgreSQL vector data types. |
| Dynamic settings |
Click the [+] button to add a row in the table and fill the Code field with a context variable to choose your database connection dynamically from multiple connections planned in your Job. This feature is useful when you need to access database tables having the same data structure but in different databases, especially when you are working in an environment where you cannot change your Job settings, for example, when your Job has to be deployed and executed independent of Talend Studio. The Dynamic settings table is available only when the Use an existing connection check box is selected in the Basic settings view. Once a dynamic parameter is defined, the Component List box in the Basic settings view becomes unusable. For examples on using dynamic parameters, see Reading data from databases through context-based dynamic connections and Reading data from different MySQL databases using dynamically loaded connection parameters. For more information on Dynamic settings and context variables, see Dynamic schema and Creating a context group and define context variables in it. |
| Limitation |
Due to license incompatibility, one or more JARs required to use this component are not provided. You can install the missing JARs for this particular component by clicking the Install button on the Component tab view. You can also find out and add all missing JARs easily on the Modules tab in the Integration perspective of Talend Studio. For details, see Installing external modules. |