Pgcli

pgcli is an interactive command-line interface and database management tool for PostgreSQL. It functions as an interactive SQL shell and query editor that allows users to inspect schemas, manage connections, and run queries against PostgreSQL data sources.

The tool is distinguished by its real-time, schema-aware autocompletion for keywords, tables, and columns, as well as dynamic SQL syntax highlighting. It provides safety mechanisms through transaction-aware guardrails that warn against or block destructive statements when no active transaction is detected.

Broad capabilities include secure database connectivity via URIs, DSNs, and SSH tunneling, along with a customizable terminal interface supporting Vi keybindings and external editor integration. The system also handles data visualization through result-set paging and multiple formatting modes, while offering utilities for SQL data export and periodic query execution.

Features

SQL Query Interfaces - Provides an interactive command-line interface for executing raw SQL queries against PostgreSQL databases.

Interactive Shells - Provides an interactive command-line interface for evaluating SQL queries with real-time session enhancements.

Interactive Query Development - Supports writing and testing complex SQL statements with real-time autocompletion of table and column names.

Command Line SQL Interfaces - Provides a terminal-based environment for executing database queries and managing PostgreSQL data structures.

Connection Managers - Establishes secure database links using standardized connection strings and DSNs.

Database Connectivity - Provides the fundamental capability to establish secure links to databases using connection strings and DSNs.

Database Management Tools - Serves as a terminal utility for inspecting schemas, managing connections, and running queries against PostgreSQL.

Interactive Data Querying Tools - Offers a terminal-based interface for querying, filtering, and exploring structured database data in real-time.

PostgreSQL Administration Tools - Provides a command-line interface for managing PostgreSQL databases with syntax highlighting and query suggestions.

Schema-Aware Autocompletion - Predicts tables, columns, and keywords based on the current input and database schema to speed up query writing.

Autocomplete Providers - Provides context-aware suggestions for SQL keywords and identifiers based on the cursor position.

Database Identifier Autocompletion - Suggests table and column names in real time to accelerate the authoring of SQL statements.

Context-Aware Autocompletion Providers - Provides real-time suggestions for tables and columns by retrieving database metadata.

Transaction Guardrails - Intercepts destructive SQL commands to trigger warnings or block execution if no active transaction is detected.

Data Formatting - Displays data in various table styles and custom date formats for improved readability.

Destructive Query Warnings - Alerts users before executing queries that may modify or delete data to prevent accidental data loss.

Table Metadata Inspection - Retrieves table definitions and column metadata using shorthand commands for schema discovery.

Result Set Pagers - Streams large database outputs through a system pager to prevent terminal overflow.

Result Renderers - Formats output as tables and provides a vertical mode for results wider than the terminal.

Database Schema Explorers - Enables inspection of PostgreSQL database structures and table definitions through an interactive shell.

Modal Editing Layers - Provides modal editing with Normal, Insert, and Replace modes for query composition.

Terminal Syntax Highlighters - Applies color-coded syntax highlighting to SQL keywords, strings, and numbers within the terminal.

Prompt Customization Toolkits - Implements an interactive terminal environment with custom prompt rendering and modal editing.

Terminal Prompt Configuration - Customizes the command line prompt to display connection status, transaction state, and user information.

Command Restrictions - Blocks or warns about destructive SQL commands when they are not wrapped within a transaction.

Secure Remote Access - Establishes secure, encrypted tunnels to remote PostgreSQL instances using SSH.

External Editor Integration - Spawns a system text editor to allow complex query modification before executing in the shell.

SQL Syntax Highlighting - Applies real-time color coding to SQL keywords and literals for improved readability.

Database and Storage Tools - Interactive PostgreSQL client with auto-completion and syntax highlighting.

Database Clients - Postgres client with autocompletion.

Database Management Systems - Terminal interface for PostgreSQL with advanced auto-completion.

Advanced CLI Tools - Postgres CLI with auto-completion and syntax highlighting.

CLI Tools - Listed in the “CLI Tools” section of the Awesome Python awesome list.

Command Line Interfaces - PostgreSQL CLI with autocompletion and syntax highlighting.

Command Line Tools - Interactive CLI with autocompletion and syntax highlighting.

CLI Tools - PostgreSQL CLI with autocompletion.

dbclipgcli

Features

Star history