Registry / database / cubejs-tiva-postgres-driver

cubejs-tiva-postgres-driver

library0.0.7jsnpmunverified

The `cubejs-tiva-postgres-driver` package is a pure JavaScript PostgreSQL database driver specifically designed for the Cube.js analytics API platform. It is a fork of the official Cube.js PostgreSQL driver, currently at version `0.0.7`. This driver enables a Cube.js backend to connect and query PostgreSQL databases. Due to its status as a fork and early version number, it likely has an irregular release cadence dictated by the needs of its maintainers rather than a public schedule. Key differentiators include its "pure JavaScript" implementation for PostgreSQL connectivity within Cube.js, and potential custom modifications unique to the "Tiva" project. It targets Node.js environments from version 14.0.0 upwards and ships with TypeScript type definitions for improved developer experience.

database web-framework

npm install cubejs-tiva-postgres-driver

github ↗package ↗

INSTALL

IMPORT

SIG · CUBEJS-TIVA-POSTGR

cubejs-tiva-postgres-driver

databasejavascriptv0.0.7

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.

PostgresDriver

✓ import { PostgresDriver } from 'cubejs-tiva-postgres-driver';

✗ const { PostgresDriver } = require('cubejs-tiva-postgres-driver');

This package is primarily designed for ESM consumption in Node.js 14+ environments. While CJS usage might be possible via bundlers, direct `require()` is not the recommended or typical pattern.

PostgresDriverOptions

✓ import type { PostgresDriverOptions } from 'cubejs-tiva-postgres-driver';

✗ import { PostgresDriverOptions } from 'cubejs-tiva-postgres-driver';

Recommended for type-checking and autocompletion when defining the driver's configuration object within your Cube.js setup. The exact type name might be `DriverConfig` or `PostgresOptions` depending on the fork's specific API.

* as TivaPostgres

✓ import * as TivaPostgres from 'cubejs-tiva-postgres-driver';

✗ const TivaPostgres = require('cubejs-tiva-postgres-driver');

This pattern imports all named exports into a namespace object, allowing access via `TivaPostgres.PostgresDriver` etc. Useful for inspecting available exports or consolidating references.

Demonstrates how to integrate the `cubejs-tiva-postgres-driver` into a basic Cube.js backend configuration using environment variables for database credentials and enabling SSL.

import { CubejsServer } from '@cubejs-backend/server'; import { PostgresDriver } from 'cubejs-tiva-postgres-driver'; const server = new CubejsServer({ // Replace with your Cube.js configuration, e.g., queryRewrite, externalRefresh // For full configuration options, refer to the Cube.js documentation. driverFactory: (context) => { // The context object can be used to pass dynamic information if needed. console.log('Initializing Tiva Postgres Driver for Cube.js context:', context); return new PostgresDriver({ host: process.env.DB_HOST ?? 'localhost', port: parseInt(process.env.DB_PORT ?? '5432', 10), user: process.env.DB_USER ?? 'cube', password: process.env.DB_PASSWORD ?? 'password', database: process.env.DB_NAME ?? 'cube_db', ssl: process.env.DB_SSL === 'true', // Set DB_SSL to 'true' for SSL connection }); }, // Additional Cube.js options can go here, e.g., `apiSecret`, `schemaPath` }); server.listen().then(({ app, port }) => { console.log(`🚀 Cube.js server is listening on http://localhost:${port}`); console.log('Access your Cube.js playground at /cubejs-api'); });

Debug

Known issues

gotchaThis package is a fork of the official Cube.js Postgres driver. It may not receive timely updates, bug fixes, or security patches from the Cube.js core team. Features and API might diverge from the official driver over time.

fix

Consider using the official `@cubejs-backend/postgres-driver` for stable and maintained functionality, unless specific modifications in this fork are critical for your project.

affects: >=0.0.1

gotchaThe package is currently at version `0.0.7`, indicating an early development stage or usage specific to a particular project. It might not be production-ready for general use and could experience frequent API changes without major version bumps.

fix

Thoroughly test in your specific environment and review the source code for stability before deploying to production. Be prepared for potential breaking changes in minor versions.

affects: >=0.0.1

breakingThis driver explicitly requires Node.js versions `^14.0.0 || ^16.0.0 || >=17.0.0`. Attempting to use older Node.js runtimes will result in compatibility errors during installation or runtime.

fix

Ensure your Node.js environment is updated to a compatible version (14.x, 16.x, or 17.x and above) to meet the engine requirements specified in `package.json`.

affects: >=0.0.1

Errors

Common errors & fixes

Error: The package 'cubejs-tiva-postgres-driver' is not compatible with your current Node.js version. Required: ^14.0.0 || ^16.0.0 || >=17.0.0. Found: v12.x.x

The installed Node.js version does not meet the minimum requirements specified in the package's `engines` field.

fix

Upgrade your Node.js environment to version 14.x, 16.x, or 17.x or newer.

TypeError: Cannot read properties of undefined (reading 'host') OR Error: Missing required connection option: host

The `driverFactory` function within your `cube.js` configuration is not providing all necessary database connection parameters (e.g., host, port, user, password, database) to the `PostgresDriver` constructor.

fix

Ensure all essential PostgreSQL connection options are passed as properties of an object to the `new PostgresDriver()` call, typically via environment variables (e.g., `process.env.DB_HOST`) or a configuration file.

SyntaxError: Cannot use import statement outside a module

You are attempting to use ECMAScript Modules (ESM) `import` syntax in a file that is being interpreted as a CommonJS (CJS) module, or in an older Node.js environment that doesn't fully support ESM.

fix

Ensure your Cube.js configuration file (e.g., `cube.js`) is treated as an ESM module by either using a `.mjs` file extension, or by adding `"type": "module"` to your `package.json` file. Alternatively, if feasible, use dynamic `import()` or stick to CJS `require()` if the package provides a CJS entry point.

Upgrade

Version history

0.0.7latest on npm

Audit

Dependencies

pgrequiredRuntime dependency for connecting to PostgreSQL databases, inherited from the official Cube.js Postgres driver.

Agent activity

12 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/sajdre/cube ↗

packagehttps://www.npmjs.com/package/cubejs-tiva-postgres-driver ↗