Command Line Interface Utilities
 
Command Line Interface Utilities
Using PSQL from the Command Line
This following topics discuss PSQL command line interface (CLI) utilities:
• CLI Utilities Overview
• Command Line Interface Tool Reference
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, macOS, and Raspbian – 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, C:\Program Files (x86)\Actian\PSQL\bin\. Since the PSQL installation places your installation directory in the PATH variable, these utilities should be available from any command prompt.
Linux, macOS, and Raspbian
On Linux and macOS, 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 PSQL Account Management on Linux, macOS, and Raspbian.
Utilities by Platform and Engine Type
The following tables outlines the command line tools, the platform where they are available, as well as whether the tool also has a graphical user interface.
Tool
Description
GUI Available
Windows
Linux or macOS
Server
Client
Server
Client
Configures PSQL components
PSQL Control Center (see Configuration Reference in Advanced Operations Guide)
Yes
Yes
Yes
Yes
Imports data into a database
No
Yes
No
Yes
No
Monitors PSQL activity
Monitor tool (see Monitoring in Advanced Operations Guide)
Yes
 
Yes
 
Creates and administers database user names and passwords
No
No
No
Yes
No
Repairs and manipulates data files
Maintenance tool (see Manipulating Btrieve Data Files with Maintenance in Advanced Operations Guide)
Yes
Yes
Yes
Yes
w64clilcadm (Windows 64-bit)
clilcadm64 (Linux or macOS 64-bit)
Applies and administers user licenses.
License Administrator (see License Administration)
Yes
No
Yes
No
w64clipaadm (Windows 64-bit)
clipaadm64 (Linux or macOS 64-bit)
Phone authorization tool used to authorize product keys when an internet connection is unavailable.
(Phone authorization only)
Phone Authorization Wizard opened by running guipaadm at a command prompt
Yes
Yes
Yes
Yes
Finds and corrects data fragmentation, rebuilds indexes, removes unused space.
Defragmenter (see Monitoring Data File Fragmentation in Advanced Operations Guide)
Yes
No
Yes
No
Creates and administers named databases
No
No
No
Yes
No
Creates and administers Engine DSNs on the server
No
No
No
Yes
Yes
isql64 (Linux or macOS 64-bit)
Allows you to run SQL statements interactively and test connectivity to a DSN.
No
No
No
Yes
Yes
w64licgetauth (Windows 64-bit)
licgetauth64 (Linux or macOS 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. Although not strictly a CLI tool, it is mentioned here for reference.
See Notification Viewer in Advanced Operations Guide.
Yes
No
Yes
No
Manipulates PSQL services
No
Yes
Yes
No
No
Configures PSQL components by editing the PSQL registry
No
No
No
Yes
Yes
Register PSQL components
No
No
No
Yes
Yes
Specifies user names and passwords for secure databases
PSQL Control Center (see PSQL Security in Advanced Operations Guide)
Yes
Yes
Yes
Yes
Processes SQL statements in a command file
PSQL Control Center (see SQL Editor)
Yes
Yes
Yes
Yes
Specifies user names and passwords for remote servers
No
Yes
Yes
Yes
Yes
Rebuilds MicroKernel data files.
Rebuild wizard (see Rebuild Tool GUI Reference in Advanced Operations Guide)
Yes
Yes
Yes
Yes
Command Line Interface Tool Reference
This section provides a reference for the following command line interface utilities:
• bcfg
• bdu
• bmon
• btadmin
• butil
• clilcadm
w64clilcadm
clilcadm64
• clipaadm
w64clipaadm
clipaadm64
• dbdefrag
• dbmaint
• dsnadd
• isql
isql64
• licgetauth
w64licgetauth
licgetauth64
• psc
• psregsvr
• pvdbpass
• pvddl
• pvnetpass
• rbldcli