{"id":18271,"library":"deep-db","title":"DEEP Database Library (deep-db)","description":"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.","status":"maintenance","version":"1.12.25","language":"javascript","source_language":"en","source_url":"https://github.com/MitocGroup/deep-framework","tags":["javascript","digital enterprise end-to-end platform","amazon web services","platform-as-a-service","deep","aws","paas","cloud","computing"],"install":[{"cmd":"npm install deep-db","lang":"bash","label":"npm"},{"cmd":"yarn add deep-db","lang":"bash","label":"yarn"},{"cmd":"pnpm add deep-db","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"deep-db is part of the deep-framework monorepo, and other core modules are required for full functionality (e.g., deployment, security).","package":"deep-framework","optional":true}],"imports":[{"note":"Named export required. Default import is not available.","wrong":"import Database from 'deep-db'","symbol":"Database","correct":"import { Database } from 'deep-db'"},{"note":"CommonJS usage also uses named destructuring. Only Database class is exported.","wrong":"const deepdb = require('deep-db')","symbol":"deep-db","correct":"const { Database } = require('deep-db')"},{"note":"getInstance is a function that returns a Database instance. Not a default instance.","wrong":"import { database } from 'deep-db'","symbol":"getInstance","correct":"import { getInstance } from 'deep-db'"}],"quickstart":{"code":"const { Database } = require('deep-db');\nconst db = new Database({\n  region: process.env.AWS_REGION ?? 'us-east-1',\n  accessKeyId: process.env.AWS_ACCESS_KEY_ID ?? '',\n  secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY ?? ''\n});\ndb.find('Users', { name: 'Alice' })\n  .then(data => console.log(JSON.stringify(data)))\n  .catch(err => console.error(err));","lang":"javascript","description":"Instantiate a Database object and perform a simple find query on a DynamoDB table called 'Users'."},"warnings":[{"fix":"Consider migrating to AWS SDK v3 DocumentClient or Dynamoose for new projects.","message":"deep-db is part of the DEEP framework which is in maintenance mode. Active development has shifted to other platforms.","severity":"deprecated","affected_versions":">=1.12.0"},{"fix":"Install deepify globally: npm install deepify -g. Then use deepify server for local testing.","message":"deep-db requires the deepify CLI tool for deployment and local development; it cannot be used standalone.","severity":"gotcha","affected_versions":"*"},{"fix":"Update to deep-framework >=1.12.31 and use Node.js >=6.x.","message":"Node.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.","severity":"breaking","affected_versions":"<1.12.31"},{"fix":"If you need multi-cloud support, consider using a different abstraction layer like Sails.js or LoopBack.","message":"deep-db is only compatible with AWS DynamoDB; no support for other databases.","severity":"gotcha","affected_versions":"*"}],"env_vars":null,"last_verified":"2026-04-25T00:00:00.000Z","next_check":"2026-07-24T00:00:00.000Z","problems":[{"fix":"Ensure you use const { Database } = require('deep-db') and then instantiate with new Database(options).","cause":"Database instance not properly instantiated or import is wrong (e.g., default import used instead of named).","error":"TypeError: Cannot read property 'find' of undefined"},{"fix":"Check your AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables, or pass them in the constructor options.","cause":"Connection to AWS failed due to missing or incorrect credentials.","error":"Error: The level of configuration is invalid: 1"},{"fix":"Run npm install deepify -g and ensure it is in your PATH.","cause":"deepify CLI not installed globally.","error":"deepify: command not found"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}