@jerrythomas/dbd

1.1.8 • Public • Published

dbd

Maintainability Test Coverage

This is a simple CLI to apply DDL scripts for individual objects for developers who are more comfortable writing SQL scripts.

  • [x] Apply a set of individual DDL scripts to a database
  • [x] Load staging data with post-process scripts for development/testing
  • [x] Export data from tables & views
  • [x] Generate dbdocs DBML for all (or subset) tables
  • [x] Support for multiple schemas where names are unique across all schemas.
  • [x] Parse files and identify dependencies. (e.g. views depend on tables)
  • [x] Combine all scripts into a single file for deployment
  • [ ] Support for multiple databases (e.g. postgres, mysql, mssql)
  • [ ] Support for multiple schemas with the same names in multiple schemas.

Refer to the pre-requisites document for setting up the dbd cli.

Usage

Install the CLI globally using npm (or pnpm/yarn)

npm i --global @jerrythomas/dbd

Folder Structure

Individual ddl scripts are expected to be placed under folders with names of the database object types. Subfolders are used to specify the schema names. Files are expected to have the same name as the object.

example

Node: The cli relies on dependencies mentioned in a yaml file (db.yaml) to execute scripts in a sequence. Refer to example folder.

Commands

Command Action
dbd init create an example repo
dbd inspect inspect and report issues
dbd combine combine all into single script
dbd apply apply the creation scripts
dbd import load seed/staging files
dbd export export tables/views
dbd dbml generate dbml files

Readme

Keywords

none

Package Sidebar

Install

npm i @jerrythomas/dbd

Weekly Downloads

1

Version

1.1.8

License

MIT

Unpacked Size

308 kB

Total Files

70

Last publish

Collaborators

  • jerrythomas