k1LoW/tbls
Tbls
tbls is a Go-based command line utility used for documenting, analyzing, and linting relational database schemas. It functions as a documentation tool that generates structured reports and entity-relationship diagrams in Markdown, JSON, or Excel formats, as well as a schema diff tool for identifying discrepancies between a live database and its documentation.
The project allows for schema augmentation and the definition of virtual relationships through external configuration files, enabling metadata overrides and table connections without requiring database migrations or native constraints. It further supports the organization of tables into domain-based viewpoints to create curated perspectives of the overall schema.
Additional capabilities include the ability to validate database structures against predefined rules via a SQL linter and the measurement of document coverage to determine the percentage of described tables and columns. The system utilizes a JSON-based driver interface to integrate external executables for supporting various database types and employs customizable templates for document generation.
Features
- Schema Documentation Generators - Generates structured database reports in Markdown, JSON, or Excel formats based on the current schema.
- Database Schema Linting - Validates database structures against predefined rules to ensure schema consistency and quality.
- Document Generation Templates - Uses customizable templates to separate logical schema data from visual representations in Markdown, JSON, or Excel.
- Database Documentation Tools - Generates structured reports and ER diagrams from database schemas in multiple formats.
- ER Diagram Generators - Automatically generates entity-relationship diagrams from database schemas to visualize table connections.
- Schema State Diffing - Compares the live database state against stored documentation to identify structural discrepancies.
- SQL Schema Linters - Checks database structures against predefined rules to ensure schema consistency and quality.
- Database Schema Diffing Tools - Identifies discrepancies between the live database state and stored documentation files.
- Database Schema Validations - Validates the live database schema against documentation to detect structural discrepancies.
- Documentation Coverage Analysis - Calculates the percentage of tables and columns that possess descriptions to measure documentation coverage.
- Table Metadata Inspection - Enables the augmentation of table and column comments via configuration without modifying the live database.
- Virtual Relationship Mapping - Specifies table relationships and foreign key connections via configuration for databases lacking native constraints.
- Schema Metadata Overrides - Allows users to add or override table and column descriptions via configuration files without requiring database migrations.
- Schema Organization - Groups tables into domain-specific categories to provide a curated perspective of the database schema.
- Schema Viewpoints - Organizes database tables into domain-based categories to create curated views of the overall schema.
- Virtual Foreign Keys - Defines table relationships and foreign key connections via configuration for databases lacking native constraints.
- Documentation Tools - CI-friendly tool for documenting databases.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
