DatabaseUpdater

Categories

Format Specific

Integrations

Workflows

Update fields in a database table based on the condition specified.

The DatabaseUpdater uses FME Writers to perform updates on tables. Each DatabaseUpdater may have its own database connection, potentially not shared with other writers and transformers. If it is necessary to share a single connection or to change options on the writer that are not available in the DatabaseUpdater, use a writer directly instead.

Updates to geometry columns are supported if the corresponding writer supports the geometry.

Note: If geometry features are null, updates may produce inconsistent results. Some writers do not update null geometry, and others update null geometries to a value of null.

See the FME Readers and Writers help for more information on how writers will respond to updating existing rows.

Unlike FME Writers, fme_db_operation and fme_where attributes are not supported on DatabaseUpdater input features.

Configuration

Input Ports

This transformer accepts any feature.

Output Ports

This transformer has no output ports.

Parameters

Format and Dataset

Select the format and dataset where the table resides, including any format-specific parameters.

Table

Specify the table to update. Click the Browse button to select the table from a list retrieved from the database. Note that you can only select this after you have completely specified the database format, dataset, and format-specific parameters.

Condition

Specify how to identify the rows to update. This can either be done through Match Column(s) or through a WHERE Clause.

WHERE Clause

Use a SQL WHERE clause to identify matching records to update. An example clause is the following:

id = 'roads'

Match On

Specify the columns and their values used to identify matching records. A record match occurs when the contents of the record for the columns listed exactly equal the corresponding value.

In the Table Column field, click the Browse button to select from a list of all the columns in the database table. Note this only works after you have completely specified the database format, dataset, format-specific parameters, and picked a table.

Columns to Update

Specify which columns to update and the values to update them with. Columns not listed, that are disabled, or that are set to “<Do Nothing>” will not be updated.

This table entry widget is automatically populated after a table is selected from the Browse button in the Table parameter.

Click the Reload button, located at the right of the table entry widget, to repopulate the table with the columns from the database table. Note reloading only works after you have completely specified the database format, dataset, format-specific parameters, and picked a table.

Automatic population fills the table with columns and tries to set their values with a convenient initial state. If a column had a value prior to populating, that value will be maintained after populating. Columns not already mapped will default to incoming attributes of the same name if one exists, otherwise it will default to “Do Nothing”.

Note that when the Condition parameter is Match Column(s), columns being matched on cannot also be updated. Instead, consider using a WHERE clause for the condition.

Editing Transformer Parameters

Using a set of menu options, transformer parameters can be assigned by referencing other elements in the workspace. More advanced functions, such as an advanced editor and an arithmetic editor, are also available in some transformers. To access a menu of these options, click beside the applicable parameter. For more information, see Transformer Parameter Menu Options.

Defining Values

There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters. There are a number of tools and shortcuts that can assist in constructing values, generally available from the drop-down context menu adjacent to the value field.

Using the Text Editor

The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.

Text Editor

Using the Arithmetic Editor

The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.

Arithmetic Editor

Conditional Values

Set values depending on one or more test conditions that either pass or fail.

Parameter Condition Definition Dialog

Content

Expressions and strings can include a number of functions, characters, parameters, and more.

When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.

String Functions

These functions manipulate and format strings.

Special Characters

 A set of control characters is available in the Text Editor.

Math Functions

Math functions are available in both editors.
Date/Time Functions Date and time functions are available in the Text Editor.

Math Operators

These operators are available in the Arithmetic Editor.

FME Feature Functions

These return primarily feature-specific values.

FME Parameters

FME and workspace-specific parameters may be used.
Creating and Modifying User Parameters Create your own editable parameters.

Dialog Options - Tables

Transformers with table-style parameters have additional tools for populating and manipulating values.

Row Reordering

Enabled once you have clicked on a row item. Choices include:

  • Add a row
  • Remove a row
  • Move current row up one
  • Move current row down one
  • Move current row to top
  • Move current row to bottom

Cut, Copy, and Paste

Enabled once you have clicked on a row item. Choices include:

  • Cut a row - delete and copy to clipboard
  • Copy a row to the clipboard
  • Paste a row from the clipboard

Cut, copy, and paste may be used within a transformer, or between transformers.

Filter

Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output.

Import

Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers.

Reset/Refresh

Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers.

Note: Not all tools are available in all transformers.

FME Community

The FME Community is the place for demos, how-tos, articles, FAQs, and more. Get answers to your questions, learn from other users, and suggest, vote, and comment on new features.

Search for all results about the DatabaseUpdater on the FME Community.