k1LoW/tbls
Tbls
tbls este un utilitar de linie de comandă bazat pe Go utilizat pentru documentarea, analizarea și linting-ul schemelor de baze de date relaționale. Acesta funcționează ca un instrument de documentare care generează rapoarte structurate și diagrame entitate-relație în formate Markdown, JSON sau Excel, precum și un instrument de diff pentru scheme pentru identificarea discrepanțelor dintre o bază de date live și documentația sa.
Proiectul permite augmentarea schemei și definirea relațiilor virtuale prin fișiere de configurare externe, permițând suprascrieri de metadate și conexiuni între tabele fără a necesita migrarea bazei de date sau constrângeri native. De asemenea, suportă organizarea tabelelor în puncte de vedere bazate pe domeniu pentru a crea perspective curatoriate ale schemei generale.
Capabilitățile suplimentare includ capacitatea de a valida structurile bazei de date în raport cu reguli predefinite printr-un linter SQL și măsurarea acoperirii documentației pentru a determina procentul de tabele și coloane descrise. Sistemul utilizează o interfață de driver bazată pe JSON pentru a integra executabile externe pentru suportul diverselor tipuri de baze de date și utilizează șabloane personalizabile pentru generarea documentelor.
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.
