Skip to content
This repository has been archived by the owner on Oct 12, 2022. It is now read-only.
/ silk Public archive

Cross-database relational database schema format (json)

Notifications You must be signed in to change notification settings

mverleg/silk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Silk

Silk is format for relational database schemas.

  • It is portable across database 'brands'
  • It uses JSON (or compatible formats, like MessagePack)
  • Structure is described with json-schema and is versioned.

Status

Version 0.1 of the schema, and accompanying Java gson objects, are available. However, this is still experimental, and there is little tooling support yet.

Uses

It could be used for:

  • Query building and checking
  • Code generation (e.g. create value src.objects to hold data from the database)
  • Test data generation

It is not intended for:

  • Data storage - only the schema (structure of data) is stored
  • Being completely comprehensive (i.e. no triggers or stored procedures)
  • Backups

Tools

  • silk_sql_gen - Generate the sql to construct the Silk schema for different databases