Registry / database / dbgate-plugin-postgres

dbgate-plugin-postgres

JSON →
library7.1.13jsnpmunverified

A PostgreSQL connector plugin for DbGate, an open-source database management tool. Current stable version is 7.1.13. Released as part of DbGate's built-in plugins, it provides seamless integration for managing PostgreSQL databases within the DbGate interface. Key differentiators include native support for PostgreSQL-specific features, automatic schema discovery, and compatibility with DbGate's query editor and visual tools.

npm install dbgate-plugin-postgres
INSTALL
IMPORT
SIG · DBGATE-PLUGIN-POST
D
dbgate-plugin-postgres
databasejavascriptv7.1.13
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

plugin
const plugin = require('dbgate-plugin-postgres')
import plugin from 'dbgate-plugin-postgres'
DbGate plugins are loaded via CommonJS require, not ESM imports. This plugin is intended to be used within the DbGate application, not directly imported by user code.
null
N/A - plugin is auto-discovered by DbGate when installed
Do not attempt to import this package directly in your own project; it is designed only to be used by DbGate.
This package is a plugin for DbGate and is not meant for direct consumption. It is automatically loaded by DbGate when installed in the same directory.
options
Configure via DbGate connection settings UI
Do not import or configure programmatically
Connection settings are managed through the DbGate GUI. There is no public API for this plugin.

Install DbGate and this PostgreSQL plugin, then configure a connection via the UI.

# Install DbGate first (globally or locally) npm install -g dbgate # Install the PostgreSQL plugin in the same directory as DbGate # (DbGate plugins are installed as npm packages) npm install dbgate-plugin-postgres # Launch DbGate dbgate # In the DbGate UI, add a new PostgreSQL connection and configure credentials.
Debug
Known issues
gotchaNsCapability setting required on macOS
fix
Add persistent access to the Documents folder or other folders as needed.
affects: all
gotchaPlugin must be installed in the same directory as DbGate (global or local node_modules)
fix
Ensure npm install is run in the same location where DbGate is installed.
affects: all
breakingPlugin v5+ requires DbGate v5+
fix
Upgrade DbGate to version 5 or later, or use older plugin version.
affects: >=5.0.0
deprecatedOlder versions (v3) used a different plugin system
fix
Migrate to DbGate's new plugin loading mechanism (see DbGate docs).
affects: <4.0.0
gotchaPostgreSQL client library (pg) is not bundled; must be installed manually for some features?
fix
If issues occur, install 'pg' package: npm install pg
affects: all
Errors
Common errors & fixes
Cannot find module 'dbgate-plugin-postgres'
Plugin not installed in the same directory as DbGate.
fix
Run npm install dbgate-plugin-postgres in the directory where DbGate is installed (usually dbgate's node_modules).
Error: The module 'dbgate-plugin-postgres' is not compatible with this version of DbGate
Plugin version mismatch with DbGate version.
fix
Check DbGate version and install a compatible plugin version (e.g., npm install dbgate-plugin-postgres@<latest_matching_version>).
connection error: client requires authentication
Missing or incorrect PostgreSQL credentials in connection settings.
fix
Verify username, password, host, port, and database name in DbGate connection config.
Role 'myuser' does not exist
PostgreSQL user not created or permissions inadequate.
fix
Create the role in PostgreSQL: CREATE ROLE myuser LOGIN PASSWORD 'password';
Upgrade
Version history
7.1.13latest on npm
Audit
Dependencies
dbgaterequiredPlugin requires DbGate as the host application to function, providing the UI and database management framework.
Agent activity
8 hits · last 30 days
node
8
Resources
dbgate-plugin-postgres — npm install dbgate-plugin-postgres · libregistry