FME Transformers: 2024.1

Categories
Integrations

Integrations

Web

Web

Workflows

Workflows

Related Transformers
AzureBlobStorageConnector
AzureFileStorageConnector
BoxConnector
CesiumIonConnector
DropboxConnector
FMEFlowResourceConnector
GoogleCloudStorageConnector
GoogleDriveConnector
OneDriveConnector
ProjectWiseWSGConnector
S3Connector
Categories
Integrations

Integrations

Web

Web

Workflows

Workflows

Related Transformers
AzureBlobStorageConnector
AzureFileStorageConnector
BoxConnector
CesiumIonConnector
DropboxConnector
FMEFlowResourceConnector
GoogleCloudStorageConnector
GoogleDriveConnector
OneDriveConnector
ProjectWiseWSGConnector
S3Connector

HDFSConnector

Accesses an HDFS (Hadoop Distributed File System) to upload, download, or delete files and folders; or list the contents of a folder from an HDFS service.

Jump to Configuration

Typical Uses

  • Manage datasets on HDFS by uploading, downloading, and deleting files and folders
  • Transfer a file's contents (such as XML, point cloud, or raster) into or out of an attribute in FME
  • Read downloaded HDFS data using the FeatureReader, or upload data written by the FeatureWriter to HDFS
  • Retrieve file and folder names, paths, links and other information from HDFS to use elsewhere in a workspace.

How does it work?

The HDFSConnector uses your HDFS account credentials (either via a previously defined FME web connection, or by setting up a new FME web connection right from the transformer) to access the file storage service.

Depending on your choice of actions, it will upload or download files, folders, and attributes; list information from the service; or delete items from the service. On uploads, path attributes are added to the output features. On List actions, file/folder information is added as attributes.

Usage Notes

  • This transformer cannot be used to directly move or copy files between different HDFS locations. However, multiple HDFSConnectors can be used to accomplish these tasks.
  • The FeatureReader can access HDFS directly (without using the HDFSConnector), however, a local copy of the dataset will not be created.

Configuration

Input Ports

This transformer accepts any feature.

Output Ports

The output of this transformer will vary depending on the HDFS Action performed.

  • After an Upload action, the HDFS path and ID of the file will be saved to an attribute.
  • A Download action can save to a file, a folder, or an attribute.
  • A Delete action has no output ports.
  • A List action will output a new feature for each file/folder found in the path specified. Each of these new features will have attributes listing various pieces of information about the object.

Features that cause the operation to fail are output through this port. An fme_rejection_code attribute, having the value ERROR_DURING_PROCESSING, will be added, along with a more descriptive fme_rejection_message attribute which contains more specific details as to the reason for the failure.

Note  If a feature comes in to the HDFSConnector already having a value for fme_rejection_code, this value will be removed.

Rejected Feature Handling: can be set to either terminate the translation or continue running when it encounters a rejected feature. This setting is available both as a default FME option and as a workspace parameter.

Parameters

HDFS Action

The type of operation to perform. Choices include:

  • Delete
  • Download
  • List
  • Upload

HDFS Account

Performing operations against an HDFS account requires the use of 1 of the 3 available authentication mechanisms (Simple, Token, Kerberos) using a Web Connection. To create an HDFS connection, click the HDFS Account drop-down box and select Add Web Connection.

The connection can then be managed via Tools > FME Options > Web Connections.

The remaining parameters available depend on the value of the Request > HDFS Action parameter. Parameters for each HDFS Action are detailed below.

HDFS Path

Path to Delete

The path of a file or folder on HDFS to delete. If valid credentials have been provided as a web connection, you may browse to a location.

HDFS Source

Download from Path

The HDFS path of the file/folder to download. If valid credentials have been provided as a web connection, you may browse to a location.

Destination

Download as

Select whether to store the downloaded data in a File, Folder, or Attribute.

  • File: The downloaded object will be stored in the specified folder.
  • Folder: The downloaded folder object will be stored in the specified folder.
  • Attribute: The downloaded object will be stored in the specified attribute. Note that this will always assume system encoding. Use the AttributeEncoder if your contents need to be a specific encoding type.

Download to Folder

Specify the path to the folder that will store the downloaded file. Valid for Download as File or Folder.

Include Subfolders

Choose whether to download subfolders of the HDFS Source or not. Valid for Download as Folder only.

Download to Attribute

Specify the attribute that will store the contents of the downloaded file. Valid for Download as Attribute only.

Note  FME will attempt to convert the attribute's contents to a UTF-8 string. If this fails, the attribute's contents will be created as raw binary. To ensure that the original bytes are always preserved and never converted to UTF-8, use Download as File instead.

HDFS Path

List Contents at Path

The folder path on HDFS to list the contents of. If valid credentials have been provided as a web connection, you may browse to a location.

Output Attributes

Attributes to Add

The selected attributes will be added to the output feature.

_name

Name of an object on HDFS.

_full_path

Path to an object on HDFS.

_id

ID of an object on HDFS.

_file_or_folder

Type (file or folder) of an object on HDFS.

_file_size

Size of a file object on HDFS.

_file_last_modified

Last modified date of an object on HDFS.

_relative_path

Relative path of an object on HDFS.

_access_time

Last accessed date of a file object on HDFS.

_block_size

Block size of a file object on HDFS.

_owner_group

The group an object on HDFS belongs to.
_owner_user Name of the user an object on HDFS belongs to.

_permissions

Octal permission code of an object on HDFS.

_replication_count

Number of replications of a file object on HDFS.

Source

Upload

The type of data to be uploaded.

  • File: The specified file will be uploaded.
  • Folder: The specified folder and its contents will be uploaded.
  • Attribute: The contents of the specified attribute will be uploaded.

When working with large objects, File is a better choice than Attribute as the data will be streamed directly from disk and not require that the object be stored entirely in memory on a feature.

HDFS treats file uploads of the same name, in a specific folder, as duplicates, so you can upload multiple files with the same name to a specific folder.

When wanting to upload content from a folder, it is better to upload as a folder instead of setting a fixed path and sending multiple features into the connector to upload as a file.

File to Upload

The file to be uploaded to HDFS if Upload is set to File.

Folder to Upload

The folder to be uploaded to HDFS if Upload is set to Folder.

Include Subfolders

Choose whether to upload subfolders of the Folder to Upload or not.

Attribute to Upload as File

The data to be uploaded, supplied from an attribute if Upload is set to Attribute.

HDFS Destination

Upload to Path

The path on HDFS to upload the source file to. To upload to the root directory, enter “/”.

Upload with File Name

The name of the file created from the data supplied in Attribute to Upload as File. The name must include a filename extension (for example, .txt, .jpg, .doc).

Upload Options

If File Exists at Destination

Choose whether to overwrite, append, or do nothing if a file exists at the upload destination.

File/Directory Permission

The octal permission (UNIX format) value to set for the uploaded object. This parameter is unavailable if “Append” is chosen for the previous parameter. The object will retain its original permission setting in this case.

Output Attributes

Attributes to Add

The selected attributes will be added to the output feature.

_full_path

Path to the file on HDFS.

_id

ID of the file/folder that was uploaded.

Editing Transformer Parameters

Transformer parameters can be set by directly entering values, using expressions, or referencing other elements in the workspace such as attribute values or user parameters. Various editors and context menus are available to assist. To see what is available, click beside the applicable parameter.

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.

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.

Table Tools

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.

For more information, see Transformer Parameter Menu Options.

Reference

Processing Behavior

Feature-Based

Feature Holding

No
Dependencies HDFS account
Aliases  
History Released FME 2018.0

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 HDFSConnector on the FME Community.