AI Tools & Scripts
Database Schema Handbook: Data Dictionary and ERD from Your Schema
For teams who inherit or hand over a database: a script parses your schema files or migrations, and your agent drafts a data dictionary, an ERD, a relationships guide and findings with source lines, for you to review. قاموس بيانات ومخطط علاقات من ملفات قاعدة بياناتك.
What you get: 1 file · 109.22 KB · ZIP
See purchase optionsProduct description
English
For developers, agencies and teams who inherit a database, hand one over, or have to explain one to a new colleague or a client.
Give your agent the database's own schema files. The agent drafts a schema handbook, for you to review: a data dictionary, a diagram, the relationships in words and a list of findings.
It reads a schema.sql, a pg_dump --schema-only file, a MySQL dump, an SQLite schema or a folder of SQL migrations applied in order. Nothing connects to a database.
Meanings the agent infers are labelled as inferred and stay unverified until your team confirms them. Views, functions and triggers are listed, not described.
What the agent writes each run
data-dictionary.mdanddata-dictionary.csv: every table and column with type, nullability, default and keys, a plain-language meaning, and the basis of that meaning: schema comment, constraint, inferred from the name, told by you, or unknown.erd.mmd: a Mermaid diagram to paste into a wiki or a README.relationships.md: each foreign key in words with its source line, many-to-many links, and join examples for the most connected tables.findings.md: factual observations, each naming the table or column and citing file and line. Examples: tables with no primary key, foreign keys with no supporting index, type mismatches across a foreign key, money-like columns stored as floating point, date-time columns with no time zone, duplicate indexes.handbook.html: one self-contained page with the diagram drawn inline, every table, the relationships, the findings and the open questions. It prints as is.
Read by a script, explained by the agent
A bundled script parses the DDL for PostgreSQL, MySQL and SQLite, applies ALTER statements and migrations in order, and records the file and line of every table, column, key and index. The agent then writes what each table and column means. A check command refuses a dictionary with a missing table or column, a stale type or a blank meaning.
Your schema only
The skill instructs the agent to label every inferred meaning, and to write what it cannot know as a [NEEDS: ...] question for your team instead of filling it in.
Honest about its limits
It documents structure as declared in the files. Row counts, data quality, index usage and what the application does at run time are not in those files, so they are not in the handbook. Meanings inferred from names are drafts to confirm. Views, functions, procedures, triggers and exclusion constraints are listed with their lines and not described. The parser is tolerant, not complete: SQL Server and Oracle files were not tried. Name-based findings are heuristics and each may be a deliberate choice. Reading ORM models (Prisma, Django, Rails) is done by the agent with a template and was not run as a test case. The HTML page and its diagram were checked as markup, not viewed in a browser; on a large schema the diagram is tall and lines can cross.
Arabic
On request the handbook is written in Arabic with a right-to-left page; table and column names stay left to right.
In the download: SKILL.md, the standard-library Python scripts, references (reading schemas, writing meanings, the findings guide, Arabic notes), templates, and a worked example you can read before you buy: a 15-table PostgreSQL clinic booking database with 116 columns and 19 foreign keys, giving 35 observations and 33 open questions.
Tried on two cases (a PostgreSQL dump in English; a MySQL shop built from 8 migrations, in Arabic). The scripts have 52 unit tests.
بالعربي
للمطوّرين والوكالات والفرق التي تستلم قاعدة بيانات أو تسلّمها أو تحتاج أن تشرحها لزميل جديد أو لعميل.
أعطِ وكيلك ملفات مخطط قاعدة البيانات (schema.sql أو ملف تفريغ أو مجلد ملفات الترحيل). يكتب لك مسودة دليل لتراجعها: قاموس بيانات، مخطط علاقات، شرح العلاقات، وقائمة ملاحظات. لا يتصل بقاعدة البيانات إطلاقًا.
ماذا يكتب الوكيل
- ملف
data-dictionary: كل جدول وكل عمود مع نوعه ومفاتيحه ومعناه، ومصدر هذا المعنى. - ملف
erd.mmd: مخطط علاقات بصيغة Mermaid. - ملف
relationships.md: كل علاقة مشروحة بالكلمات مع أمثلة ربط. - ملف
findings.md: ملاحظات واقعية، مع كل ملاحظة اسم الملف ورقم السطر. - ملف
handbook.html: صفحة واحدة جاهزة للطباعة.
حدودها
توثّق البنية كما هي مكتوبة في الملفات فقط، فلا ترى البيانات نفسها ولا ما يفعله التطبيق. المعاني المستنتجة من الأسماء مسودات تحتاج تأكيدك، وما لا يُعرف يُكتب سؤالًا لفريقك. تدعم PostgreSQL و MySQL و SQLite. يمكن طلب الدليل بالعربية؛ جُرّب ذلك على حالة اختبار واحدة.
Questions / أسئلة
Does it connect to my database? / هل يتصل بقاعدة البيانات؟
No. It reads schema files on your disk and nothing else. لا، يقرأ الملفات فقط.
Which databases does it read? / أي قواعد بيانات يدعم؟
PostgreSQL, MySQL and SQLite schema files, or a folder of SQL migrations applied in order. SQL Server and Oracle were not tried. يدعم PostgreSQL و MySQL و SQLite.
I only have migrations, no schema file. / عندي ملفات ترحيل فقط.
Point it at the folder. The script applies the migrations in order, including renames and dropped columns, and keeps a short history. وجّهه إلى المجلد وسيطبّقها بالترتيب.
How does it know what a column means? / كيف يعرف معنى العمود؟
From schema comments, constraints and names, or from what you tell it. Each meaning is labelled with its basis, and what stays unknown is written as a question. كل معنى مكتوب معه مصدره.
Will it tell me my schema is wrong? / هل يحكم على المخطط؟
It lists observations with their source lines for your team to review. Each may be a deliberate choice. يسرد ملاحظات للمراجعة ولا يصدر أحكامًا.
Can the handbook be in Arabic? / هل يكون الدليل بالعربي؟
Yes, with a right-to-left page and identifiers kept left to right. It was tried on one test case. نعم، مع صفحة من اليمين إلى اليسار.
What you get
1 file · 109.22 KB
- schema-handbook-1.0.0.zipZIP · 109.22 KB
AI Tools & Scripts
Database Schema Handbook: Data Dictionary and ERD from Your Schema
For teams who inherit or hand over a database: a script parses your schema files or migrations, and your agent drafts a data dictionary, an ERD, a relationships guide and findings with source lines, for you to review. قاموس بيانات ومخطط علاقات من ملفات قاعدة بياناتك.
Getly opened the uploaded files and found nothing that would stop them opening. It is not a virus scan or a quality rating.
Tags
Frequently asked questions
Do I get access instantly?
Yes. This is a digital product - you can download it right after checkout, straight from your library.
Can I use it for commercial projects?
Yes. Commercial use is allowed: use it in your own business and in things you sell. You may not resell or redistribute the file itself.
What's your refund policy?
You can request a refund within 30 days. If something isn't right, request it from your order and the Getly team reviews it.
What file formats and sizes will I get?
You'll download 1 file - ZIP - 109.22 KB in total.
Do I get free updates?
Yes - when the seller ships a new version, you can re-download the latest files from your library at no extra cost. Check the changelog for recent updates.
Price
$7.00



