Skip to content

Latest commit

 

History

History
 
 

models

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

@azimutt/models

A library defining common models and utilities for Azimutt.

Main models:

  • database: defines a generic database infos (structure & stats), used for every connector and serde
  • project: defines an Azimutt project, holding everything
  • connector: defines the interface to connect to any database
  • serde: defines the interface to parse and generate database schema

Here are the main utilities:

  • infer schema: infer a schema from a list of JSON objects
  • infer relations: infer relations between tables based on column names and values

Publish

  • update package.json version
  • update lib versions (pnpm -w run update + manual)
  • test with pnpm run dry-publish and check azimutt-models-x.y.z.tgz content
  • launch pnpm publish --no-git-checks --access public

View it on npm.

Dev

If you need to develop on multiple libs at the same time (ex: want to update a connector and try it through the CLI), depend on local libs but publish & revert before commit.

  • Depend on a local lib: pnpm add <lib>, ex: pnpm add @azimutt/utils
  • "Publish" lib locally by building it: pnpm run build