gpfdist.exe

gpfdist.exe

Serves data files to or writes data files out from Greenplum Database segments.

Synopsis

gpfdist.exe [-d directory] [-p http_port] [-l log_file] [-t timeout] 
   [-S] [-w time] [-v | -V] [-s] [-m max_length] [--ssl certificate_path]

gpfdist.exe -? | --help 

gpfdist.exe --version

Description

gpfdist.exe is Greenplum's parallel file distribution program. It is used by readable external tables and gpload.py to serve external table files to all Greenplum Database segments in parallel. It is used by writable external tables to accept output streams from Greenplum Database segments in parallel and write them out to a file.

In order for gpfdist.exe to be used by an external table, the LOCATION clause of the external table definition must specify the external table data using the gpfdist:// protocol (see the Greenplum Database command CREATE EXTERNAL TABLE).

Note: If the --ssl option is specified to enable SSL security, create the external table with the gpfdists:// protocol.

The benefit of using gpfdist.exe is that you are guaranteed maximum parallelism while reading from or writing to external tables, thereby offering the best performance as well as easier administration of external tables.

For readable external tables, gpfdist.exe parses and serves data files evenly to all the segment instances in the Greenplum Database system when users SELECT from the external table. For writable external tables, gpfdist.exe accepts parallel output streams from the segments when users INSERT into the external table, and writes to an output file.

For readable external tables, if load files are compressed using gzip or bzip2 (have a .gz or .bz2 file extension), gpfdist.exe uncompresses the files automatically before loading provided that gunzip or bunzip2 is in your path.

Note: Currently, readable external tables do not support compression on Windows platforms, and writable external tables do not support compression on any platforms.

Most likely, you will want to run gpfdist.exe on your ETL machines rather than the hosts where Greenplum Database is installed. To install gpfdist.exe on another host, simply copy the utility over to that host and add gpfdist.exe to your PATH.

Note: When using IPv6, always enclose the numeric IP address in brackets.

You can also run gpfdist.exe as a Windows Service. See Running gpfdist as a Windows Service for more details.

Options

-d directory
The directory from which gpfdist.exe will serve files for readable external tables or create output files for writable external tables. If not specified, defaults to the current directory.
-l log_file
The fully qualified path and log file name where standard output messages are to be logged.
-p http_port
The HTTP port on which gpfdist.exe will serve files. Defaults to 8080.
-t timeout
Sets the time allowed for Greenplum Database to establish a connection to a gpfdist.exe process. Default is 5 seconds. Allowed values are 2 to 7200 seconds (2 hours). May need to be increased on systems with a lot of network traffic.
-m max_length
Sets the maximum allowed data row length in bytes. Default is 32768. Should be used when user data includes very wide rows (or when line too long error message occurs). Should not be used otherwise as it increases resource allocation. Valid range is 32K to 256MB. (The upper limit is 1MB on Windows systems.)
Note: Memory issues might occur if you specify a large maximum row length and run a large number of gpfdist concurrent connections. For example, setting this value to the maximum of 1MB with 96 concurrent gpfdist processes requires approximately 97GB of memory ((96 + 1) x 1MB).
-s

Enables simplified logging. When this option is specified, only messages with WARN level and higher are written to the gpfdist log file. INFO level messages are not written to the log file. If this option is not specified, all gpfdist messages are written to the log file.

You can specify this option to reduce the information written to the log file.
-S (use O_SYNC)
Opens the file for synchronous I/O with the O_SYNC flag. Any writes to the resulting file descriptor block gpfdist.exe until the data is physically written to the underlying hardware.
-w time
Sets the number of seconds that Greenplum Database delays before closing a target file such as a named pipe. The default value is 0, no delay. The maximum value is 7200 seconds (2 hours).
For a Greenplum Database with multiple segments, there might be a delay between segments when writing data from different segments to the file. You can specify a time to wait before Greenplum Database closes the file to ensure all the data is written to the file.
--ssl certificate_path
Adds SSL encryption to data transferred with gpfdist.exe. After executing gpfdist.exe with the --ssl certificate_path option, the only way to load data from this file server is with the gpfdist:// protocol. For information on the gpfdist:// protocol, see "Loading and Unloading Data" in the Greenplum Database Administrator Guide.
The location specified in certificate_path must contain the following files:
  • The server certificate file, server.crt
  • The server private key file, server.key
  • The trusted certificate authorities, root.crt

The root directory (/) cannot be specified as certificate_path.

-v (verbose)
Verbose mode shows progress and status messages.
-V (very verbose)
Verbose mode shows all output messages generated by this utility.
-? (help)
Displays the online help.
--version
Displays the version of this utility.

Running gpfdist as a Windows Service

Greenplum Loaders allow gpfdist.exe to run as a Windows Service.

Follow the instructions below to download, register and activate gpfdist.exe as a service:

  1. Update your Greenplum Loader package to the latest version. This package is available from Pivotal Network.
  2. Register gpfdist as a Windows service:
    1. Open a Windows command window
    2. Run the following command:
      sc create gpfdist binpath= "path_to_gpfdist.exe -p 8081 -d External\load\files\path -l Log\file\path"

      You can create multiple instances of gpfdist by running the same command again, with a unique name and port number for each instance:

      sc create gpfdistN binpath= "path_to_gpfdist.exe -p 8082 -d External\load\files\path -l Log\file\path"
  3. Activate the gpfdist service:
    1. Open the Windows Control Panel and select Administrative Tools > Services.
    2. Highlight then right-click on the gpfdist service in the list of services.
    3. Select Properties from the right-click menu, the Service Properties window opens.

      Note that you can also stop this service from the Service Properties window.

    4. Optional: Change the Startup Type to Automatic (after a system restart, this service will be running), then under Service status, click Start.
    5. Click OK.

Repeat the above steps for each instance of gpfdist that you created.

Examples

To serve files from a specified directory using port 8081 (and start gpfdist.exe in the background):

gpfdist.exe -d /var/load_files -p 8081 &

To start gpfdist.exe in the background and redirect output and errors to a log file:

gpfdist.exe -d /var/load_files -p 8081 -l /home/gpadmin/log &

See Also

gpload.py, CREATE EXTERNAL TABLE in the Greenplum Database Reference Guide