CLI Utilities Overview
In addition to providing GUI utilities, PSQL provides a number of command line interface (CLI) utilities that you can use. In most cases, these utilities duplicate functionality you can perform with GUI utilities.
For default locations of PSQL files, see Where are the PSQL files installed? in Getting Started with PSQL.
Platforms that Include CLI Utilities
These utilities are provided in the following installations:
•
Windows - Server, Workgroup, and a limited set on the Client
•
Linux or OS X - Server, and a limited set on the Client
The summary of utilities in the section that follows notes which utilities are present in a server or client install.
Where to Find CLI Utilities
Please note the location based on your platform.
Windows
In Windows, the utilities are installed to the BIN directory of your PSQL installation. If you installed to the default installation location, your utilities are located in file_path\PSQL\bin\. Since the PSQL installation places your install directory in the PATH, these utilities should be available from any command prompt.
Linux or OS X
On Linux and OS X, utilities are installed to /usr/local/psql/bin. The user psql has the necessary environment variables to use the utilities. If you wish to use utilities from accounts other than psql, follow these instructions in Getting Started with PSQL: PSQL Account Management on Linux and OS X.
Utilities by Platform and Engine Type
The following tables outlines the command line utilities, the platform on which they are made available, as well as if a graphical user interface is available for the utility.
Utility
Description
GUI Available
Windows
Linux or OS X
Server
Client
Server
Client
bcfg
Configures PSQL components
PSQL Control Center (see Configuration Reference in Advanced Operations Guide)
Yes
Yes
Yes
Yes
bdu
Imports data into a database
No
Yes
No
Yes
No
bmon
Monitors PSQL activity
Monitor Utility (see Monitoring in Advanced Operations Guide)
Yes
 
Yes
 
btadmin
Creates and administers database user names and passwords
No
No
No
Yes
No
butil
Repairs and manipulates data files
Maintenance Utility (see Manipulating Btrieve Data Files with Maintenance in Advanced Operations Guide)
Yes
Yes
Yes
Yes
clilcadm
w64clilcadm (Windows 64-bit)
clilcadm64 (Linux or OS X 64-bit)
Applies and administers user licenses.
License Administrator (see License Administration)
Yes
No
Yes
No
clipaadm
w64clipaadm (Windows 64-bit)
clipaadm64 (Linux or OS X 64-bit)
Phone Authorization Utility used to authorize product keys when internet connection is unavailable.
(Phone Authorization Only)
PSQL Phone Authorization Wizard
Yes
Yes
Yes
Yes
dbdefrag
Finds and corrects data fragmentation, rebuilds indexes, removes unused space.
Yes
Yes
No
Yes
No
dbmaint
Creates and administers named databases
No
No
No
Yes
No
dsnadd
Creates and administers Engine DSNs on the server
No
No
No
Yes
Yes
isql
isql64 (Linux or OS X 64-bit)
Allows you to run SQL statements interactively and test connectivity to a DSN.
No
No
No
Yes
Yes
licgetauth
w64licgetauth (Windows 64-bit)
licgetauth64 (Linux or OS X 64-bit)
Transmits Authorization Request Data and retrieves Authorization Key Data.
(Offline Authorization Only)
No
Yes
Yes
Yes
Yes
Notification Viewer
Notification Viewer provides two interfaces: system tray icons and a graphical user interface (GUI). Although not strictly a CLI utility, it is mentioned here for reference. See Notification Viewer in Advanced Operations Guide.
Yes
Yes
No
Yes
No
psc
Manipulates PSQL services
No
Yes
Yes
No
No
psregedit
Configures PSQL components by editing the PSQL registry
No
No
No
Yes
Yes
psregsvr
Register PSQL components
No
No
No
Yes
Yes
pvdbpass
Specifies user names and passwords for secure databases
PSQL Control Center (see PSQL Security in Advanced Operations Guide)
Yes
Yes
Yes
Yes
pvddl
Processes SQL statements in a command file
PSQL Control Center (see SQL Editor)
Yes
Yes
Yes
Yes
pvnetpass
Specifies user names and passwords for remote servers
No
Yes
Yes
Yes
Yes
rbldcli
Rebuilds MicroKernel data files.
Yes
Yes
Yes
Yes
Yes