Registry / database / dbgate-serve-premium

dbgate-serve-premium

library7.1.9jsnpmunverified

DbGate Serve Premium is the commercial, web-based server component of the DbGate database administration tool, currently at version 7.1.9. It provides a cross-platform solution for managing a wide array of databases, including MySQL, PostgreSQL, SQL Server, Oracle, MongoDB, Redis, SQLite, CockroachDB, MariaDB, and ClickHouse, with premium support for Amazon Redshift and CosmosDB. This package is distinguished from the community `dbgate-serve` by offering additional commercial features, such as enhanced storage options via `STORAGE_SERVER` environment variables, enabling persistent server-side metadata and connection management. It maintains an active release cadence, frequently publishing updates and bug fixes. Key functionalities include schema comparison, a visual query designer, advanced chart visualizations, and robust batch export/import capabilities. Unlike its desktop application counterpart, `dbgate-serve-premium` runs as a standalone web server, accessible through a browser, facilitating remote database management and collaboration.

database

npm install dbgate-serve-premium

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · DBGATE-SERVE-PREMI

dbgate-serve-premium

databasejavascriptv7.1.9

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

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

DbGateServePremiumCLI

✓ /* This package is primarily a CLI tool. Its functionality is accessed via the 'dbgate-serve-premium' command, not through direct programmatic imports. */

DbGate Serve Premium is a command-line interface (CLI) application designed for server deployment. It does not expose standard JavaScript symbols for direct `import` or `require()` in user code. For programmatic interaction with DbGate functionality, developers should refer to the `dbgate-api` package.

query

✓ import { query } from 'dbgate-api';

✗ const query = require('dbgate-api').query;

For executing database queries programmatically within the DbGate ecosystem, use the `dbgate-api` package. This provides a dedicated interface for integrating DbGate's data access capabilities into your JavaScript/TypeScript applications, separate from the `dbgate-serve-premium` CLI.

connect

✓ import { connect } from 'dbgate-api';

✗ const connect = require('dbgate-api').connect;

To establish and manage database connections programmatically in the DbGate ecosystem, the `dbgate-api` package offers functions like `connect`. This is distinct from the `dbgate-serve-premium` CLI, which manages connections via its web interface.

Demonstrates global installation and startup of the DbGate Serve Premium web server, including an example for .env file configuration.

npm install -g dbgate-serve-premium # Create a .env file in your working directory for configuration # Example .env file for a MySQL connection (premium feature) # STORAGE_SERVER=localhost # STORAGE_USER=root # STORAGE_PASSWORD=mypassword # STORAGE_DATABASE=dbname # STORAGE_ENGINE=mysql@dbgate-plugin-mysql # (Note: STORAGE_xxx variables are specific to the Premium edition and store DbGate's metadata) # Start the DbGate Premium server dbgate-serve-premium # Then open http://localhost:3000 in your browser to access the web interface.

Debug

Known issues

gotchaDbGate Serve Premium is primarily a CLI application and is not designed for direct programmatic import into JavaScript/TypeScript projects. Its functionality is accessed by running the `dbgate-serve-premium` command from the terminal. For programmatic interaction with DbGate's core features (e.g., querying databases, managing connections), use the `dbgate-api` package instead.

fix

Do not attempt to `import` or `require()` 'dbgate-serve-premium' directly. Install and run it globally via `npm install -g dbgate-serve-premium` and `dbgate-serve-premium`. For code integration, use `dbgate-api`.

affects: >=1.0.0

breakingAs of v7.1.9, the public DbGate cloud infrastructure and endpoints were migrated. This change could potentially affect existing integrations or direct cloud connectivity if hardcoded endpoints were used, though it aims to improve availability and resilience.

fix

Verify any custom integrations or direct API calls that might rely on older DbGate cloud endpoints. For most users, this change should be transparent, but manual configurations might require updates.

affects: >=7.1.9

gotchaOracle database connections using 'thick mode' (Oracle Instant Client) require manual installation and specific environment variable configuration (e.g., `ORACLE_INSTANT_CLIENT`). Without it, certain Oracle features or older Oracle server versions may not be supported (thin mode limitations apply).

fix

Download and unpack Oracle Instant Client to a known location. Set the `ORACLE_INSTANT_CLIENT` environment variable to its directory path. Consult DbGate documentation and `node-oracledb` for details on thick vs. thin mode capabilities and required environment variables like `NLS_LANG`.

affects: >=1.0.0

gotchaConfiguration of DbGate Serve Premium is primarily managed through environment variables, typically loaded from `.env` files in the working directory. It is crucial to handle sensitive information (e.g., `STORAGE_PASSWORD`) securely and ensure `.env` files are not committed to version control.

fix

Utilize a `.env` file for local development but add it to your `.gitignore`. For production environments, manage environment variables securely through your deployment platform's mechanisms, rather than relying on `.env` files.

affects: >=1.0.0

breakingVersion 7.1.9 introduced stricter validation for function and file names, along with fixes for security issues. This means previously accepted, potentially unsafe names or patterns in configurations might now be rejected, leading to unexpected behavior or errors.

fix

Review any custom function or file names used within DbGate configurations and ensure they comply with standard naming conventions. Upgrade to the latest version to benefit from these crucial security patches and validation improvements.

affects: >=7.1.9

Errors

Common errors & fixes

Error: SQL error: UUID parsing issues

Specific formats of UUIDs were not correctly parsed when interacting with databases, leading to errors in operations involving UUID columns.

fix

This issue was fixed in DbGate Serve Premium v7.1.9. Upgrade to version 7.1.9 or later to resolve UUID parsing problems (#1434, #1431).

TypeError: Cannot read properties of undefined (reading 'writeQueryHistory')

An internal error prevented the `writeQueryHistory` function from executing correctly, often due to an undefined context or missing dependency within the server.

fix

This specific bug was resolved in DbGate Serve Premium v7.1.9. Upgrade to this version or newer to fix the `writeQueryHistory` function error (#1432).

Error: Export failure when password mode is enabled

Export operations failed to complete successfully when the connected database required a password, indicating an issue with credential handling during the export process.

fix

This problem was fixed in DbGate Serve Premium v7.1.7. Upgrade to version 7.1.7 or later to resolve export failures when password mode is enabled (#1409).

ORA-24960: the Oracle environment variable NLS_LANG is not set

When using Oracle Instant Client (thick mode), the `NLS_LANG` environment variable is required by Oracle to correctly handle character sets, and its absence causes connection errors.

fix

Before running DbGate, ensure the `NLS_LANG` environment variable is set in your system environment (e.g., `export NLS_LANG=AMERICAN_AMERICA.AL32UTF8` on Linux/macOS, or via System Properties on Windows). Consult Oracle Instant Client documentation for the appropriate value for your locale.

Upgrade

Version history

7.1.9latest on npm

Audit

Dependencies

dbgate-plugin-mysqloptionalUsed for MySQL database connectivity, as indicated by the STORAGE_ENGINE environment variable example. DbGate dynamically loads various database plugins; others would be specific to connected databases.

Agent activity

10 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/dbgate/dbgate ↗

packagehttps://www.npmjs.com/package/dbgate-serve-premium ↗

homepagehttps://dbgate.org ↗