Microsoft SQL Server and Azure SQL Database Spatial (JDBC) Writer Feature Type Parameters

To access feature type parameters, click the gear icon on a feature type in the workspace to open the Feature Type Parameter Editor. To always display the editor in Workbench, you can select View > Windows > Parameter Editor.

General

All feature types share similar General parameters, which may include the Feature Type Name, Reader or Writer Name, and Geometry.

In most Writer Feature Type parameter dialogs, you can also control Dynamic Schema Definitions. Some database formats accept a Table Qualifier prefix on the output table feature type.

See Editing Writer Feature Types for more information.

These parameters apply only to a selected feature type, not to the entire writer.

Tip: If a feature type parameter listed here conflicts with a writer-level parameter, then the writer parameter will be ignored and this feature type parameter will be used.

Table Settings: General

ClosedFeature Operation

This parameter lets the user specify how features will be written into the destination table. Supported feature operations are:

  • Insert: Append rows onto the destination table using attributes on features.
  • Update: Update existing table columns using attributes on features. A selection method must be specified in the Row Selection group.
  • Delete: Delete existing table rows. A selection method must be specified in the Row Selection group.
  • fme_db_operation: The feature operation will be determined by the attribute fme_db_operation on each input feature. A selection method must be specified in the Row Selection group. The value of fme_db_operation will be processed as follows:
    • If the value is null, empty, or missing, it will be treated as Insert.
    • The value will next be matched to Insert, Update, and Delete, case insensitively.
    • If there is no match, the feature will be rejected.
    • If there is a match, the matched feature operation will be performed on the feature.

Tip: The fme_db_operation attribute will now cause feature rejection when Feature Operation is set to Insert, Update, or Delete. This behavior differs from previous versions of FME.

More information on Feature Operations.

ClosedTable Handling (also called List Handling in some formats)

Controls how the feature type handles destination tables or lists. These options are available:

  • Use Existing: Write to an existing table or list. If the destination table/list does not exist, the translation will fail.
  • Create If Needed: Create destination table/list if it does not exist.
  • Drop and Create: Drop destination table/list if it exists, and then create it. The writer will drop and re-create the table before writing any features to it. Tables will be overwritten when the first input feature is processed. If no features are sent to a feature type, then the corresponding table will not be overwritten.
  • Truncate Existing: (This option is not available for all formats.) If destination table/list does not exist, the translation will fail. Otherwise, delete all rows from existing table or list.
ClosedUpdate Spatial Column(s)

This parameter tells the writer whether to update or skip spatial column(s) when updating features:

  • Yes: The spatial column(s) specified by the user will be updated. IFMENulls will be written as null values and replace existing spatial values.
  • No: No spatial columns will be updated.

Row Selection

When inserting into a table, Row Selection is ignored. When updating and deleting from a table (if applicable, based on a format's available Feature Operation options), a condition needs to be specified for selecting which rows to operate on. This parameter group offers two methods to construct the selection condition:

ClosedMatch Columns

The columns specified in the corresponding column picker dialog will be used for matching destination rows. All matching rows will be selected for update or delete. If any feature attributes corresponding to the specified match columns contain null or missing values, the feature will be rejected.

ClosedWHERE Clause

This parameter opens a WHERE Clause Builder. You can also type a WHERE clause inline, without launching the Builder. It is optional to start the clause with the word WHERE.

The WHERE Clause Builder makes it easy for users to reference feature attribute values, destination table columns, and invoke FME functions. The WHERE clause is first evaluated as an FME expression, before being passed onto the destination database.

If the WHERE clause is incorrect or if its evaluation results in failure, the translation will fail. Otherwise, if the WHERE clause passes FME evaluation but it is SQL invalid, the feature will be rejected or the translation will fail.

For advanced users, conditional FME expressions created through the Conditional Value editor can be used to create WHERE clauses.

Tip: You can set the WHERE Clause to an attribute. This supports workspace migration and existing workflows involving fme_where. (Direct support for fme_where has been deprecated.) To advanced users who are accustomed to using fme_where, if Feature Operation is set to Update, Delete, or fme_db_operation, an fme_where attribute that conflicts with Match Columns or WHERE Clause will result in feature rejection.

Use Bulk Insert

This parameter is only available when Feature Operation is Insert.

A SQL Server writer can toggle this parameter on and off, while an Azure SQL Database writer will always have this parameter enabled.

If enabled, the writer performs INSERT operations using bulk insert, which offers significant performance improvements.

ClosedCheck Constraints

When inserting features, this parameter determines whether rows being inserted are checked against constraints defined on the destination table or column(s).

  • Yes: Inserted rows are checked against any defined constraints.
  • No: Rows are inserted without checking constraints.
ClosedFire Insert Triggers

This parameter determines whether insert triggers are fired after features are inserted.

A trigger is a kind of stored procedure that automatically executes when an event occurs in the database server.

  • Yes: Any insert triggers defined on the destination table fire after rows are inserted.
  • No: Rows are inserted without firing insert triggers.

For more information on triggers, see CREATE TRIGGER (Transact-SQL) in the Microsoft Docs.

ClosedInsert Into Identity Column

When inserting features, this parameter determines whether identity columns are auto-populated.

Identity columns are columns whose values are automatically populated by the database server in sequence. This parameter allows you to override this behavior and provide the values.

There can be, at most, one identity column specified per table.

  • Yes: The destination identity column, if defined, is populated with values from the feature attribute that corresponds to the identity column.
  • No: The destination identity column is auto-populated by the database server.

This parameter does not affect other feature operations.

For more information on identity columns, see IDENTITY (Property) (Transact-SQL) in the Microsoft Docs.

ClosedInsert Null Values

When inserting features, this parameter determines whether null values are preserved when writing into columns that have a default value.

A default specifies a value to be inserted into the column when no value is explicitly supplied during an insert.

  • Yes: If a default value is specified for a column, and the feature attribute that corresponds to the column is null or missing, the default value is ignored, and the value <null< is written to the destination column.
  • No: The database writes the default value for the column instead of <null>.

For more information on default values, see CREATE DEFAULT (Transact-SQL) in the Microsoft Docs.