This section provides the information required to set up your Greenplum Database client runtime environment and use the client and loader tools. Topics include:
Before using the client and loader tools, ensure that:
gpssutility programs, network connectivity must also exist between the client machine and all Greenplum Database segment hosts.
Contact your Greenplum Database administrator if you do not meet the prerequisites mentioned above.
The client and loader tools package installs a file that you use to set up your Greenplum Database client and loader environment. This script or batch file, named
greenplum_clients_path.<ext> (where the file extension
<ext> is operating system- or shell-dependent) is located in the client tools root install directory.
$GPHOME_CLIENTSenvironment variable to point to the root directory of the client and loader tools installation.
You must source or run
greenplum_clients_path.<ext> before you invoke any of the client or loader programs. For example, run the following command on a CentOS or Ubuntu system to source the file:
user@clientsys$ . /usr/local/greenplum-db-clients/greenplum_clients_path.sh
Consider adding the command to source or run
greenplum_clients_path.<ext>to your shell or equivalent initialization file.
Clients always connect to Greenplum Database through the master host. In order for the client or loader program to establish a connection to the master host, you provide the following connection parameters to the program via options, a configuration file, or environment variables:
|Connection Parameter||Description||Environment Variable Name|
|Database name||The name of the database to which you want to connect.||PGDATABASE|
|Host name||The host name of the Greenplum Database master. The default host is the local host.||PGHOST|
|Port||The port number on which the Greenplum Database master server instance is running. The default port is 5432.||PGPORT|
|User name||The Greenplum Database user (role) name. This name may not necessarily be the same as your operating system user name.||PGUSER|
Refer to the Client and Loader Utility Reference for the client or load command to determine tool support for specifying these connection parameters via options, configuration property names, and/or environment variables.
The following Greenplum Database documentation topics provide additional information about using selected client and loader tools:
gpfdist- Using the Greenplum Parallel File Server (gpfdist)
gpkafka- Loading from a Kafka data source in the VMware Tanzu Greenplum Streaming Server documentation
gpload- Loading Data with gpload
gpsscli- VMware Tanzu Greenplum Streaming Server documentation
psql- Connecting with psql
Keep in mind these additional considerations when you use the Windows client and load programs:
gploadcontrol file are unblocked by any firewall running on the Windows client system.
gpload.batattempts to create a directory named
gpAdminLogin the directory from which you execute the program, and writes its log files there. This operation will fail if you do not have write permission to the current working directory. Run
-loption to direct the log output to a different location.