deep-db

library1.12.25jsnpmunverified

deep-db is the database module of the DEEP Framework, an enterprise-level cloud-native framework for building serverless applications on AWS. Version 1.12.25 is part of the deep-framework monorepo, which has seen active maintenance up to v1.12.46, with updates focused on AWS region support, bug fixes, and Node.js compatibility (v4.3+ to v6.x). It provides abstracted database operations over AWS DynamoDB, offering find, get, and partition management features. Uniquely, it is tightly integrated with the DEEP ecosystem, requiring the deepify CLI tool for deployment and local development. This library is not intended for standalone use outside the DEEP framework and is largely dependent on other DEEP modules and AWS services. Alternatives include direct use of AWS SDK DynamoDB client or other DynamoDB abstraction layers like Dynamoose or document client.

database aws

npm install deep-db

github ↗package ↗

INSTALL

IMPORT

SIG · DEEP-DB

deep-db

databasejavascriptv1.12.25

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.

Database

✓ import { Database } from 'deep-db'

✗ import Database from 'deep-db'

Named export required. Default import is not available.

deep-db

✓ const { Database } = require('deep-db')

✗ const deepdb = require('deep-db')

CommonJS usage also uses named destructuring. Only Database class is exported.

getInstance

✓ import { getInstance } from 'deep-db'

✗ import { database } from 'deep-db'

getInstance is a function that returns a Database instance. Not a default instance.

Instantiate a Database object and perform a simple find query on a DynamoDB table called 'Users'.

const { Database } = require('deep-db'); const db = new Database({ region: process.env.AWS_REGION ?? 'us-east-1', accessKeyId: process.env.AWS_ACCESS_KEY_ID ?? '', secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY ?? '' }); db.find('Users', { name: 'Alice' }) .then(data => console.log(JSON.stringify(data))) .catch(err => console.error(err));

Debug

Known issues

deprecateddeep-db is part of the DEEP framework which is in maintenance mode. Active development has shifted to other platforms.

fix

Consider migrating to AWS SDK v3 DocumentClient or Dynamoose for new projects.

affects: >=1.12.0

gotchadeep-db requires the deepify CLI tool for deployment and local development; it cannot be used standalone.

fix

Install deepify globally: npm install deepify -g. Then use deepify server for local testing.

affects: *

breakingNode.js v6.x migration in v1.12.31 dropped support for Node.js v4.x. Older versions may not work on new AWS Lambda Node.js runtimes.

fix

Update to deep-framework >=1.12.31 and use Node.js >=6.x.

affects: <1.12.31

gotchadeep-db is only compatible with AWS DynamoDB; no support for other databases.

fix

If you need multi-cloud support, consider using a different abstraction layer like Sails.js or LoopBack.

affects: *

Errors

Common errors & fixes

TypeError: Cannot read property 'find' of undefined

Database instance not properly instantiated or import is wrong (e.g., default import used instead of named).

fix

Ensure you use const { Database } = require('deep-db') and then instantiate with new Database(options).

Error: The level of configuration is invalid: 1

Connection to AWS failed due to missing or incorrect credentials.

fix

Check your AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables, or pass them in the constructor options.

deepify: command not found

deepify CLI not installed globally.

fix

Run npm install deepify -g and ensure it is in your PATH.

Upgrade

Version history

1.12.25latest on npm

Audit

Dependencies

deep-frameworkoptionaldeep-db is part of the deep-framework monorepo, and other core modules are required for full functionality (e.g., deployment, security).

Agent activity

18 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/MitocGroup/deep-framework ↗

packagehttps://www.npmjs.com/package/deep-db ↗