postgresql adatbázis dokumentálása

Adatbázis: SQL, XML DB

Sziasztok!

Van egy viszonylag bonyolult SQL adatbázisom, és ezt kéne viszonylag egyszerűen dokumentálni.
Az autodoc-al próbálkozom, mivel se jobbat, sőt igazán rosszabbat sem találtam ilyen célra.
Néhány mezőnél szükség lenne hosszabb magyarázó szövegre, és legalább annyi formázási lehetőségre, hogy egy soremelést be tudjak szúrni. Van erre bármi lehetőség?
Esetleg létezik bármilyen eszköz, ami rugalmasabb mint az autodoc.

  • 2542 megtekintés

( csfeco | 2015. 01. 31., szo – 09:24 )

Gondolom valami eszköz csak létezik egy SQL adatbázis dokumentálására, azon kívül, hogy fogok egy szövegszerkesztőt, vagy esetleg egy diagram rajzolót? Mert az nagyon fapadosnak tűnik így a 21. században, főleg amióta rászoktam a doxygen-re.

Sejtem, hogy azért nem kapsz választ, mert nem árultad el, hogy mit értesz a vágyott dokumentáció alatt: szöveges listát az objektumdefiníciókkal (milyen részletességben?), szövegest listát, ami azért valahogyan jelzi a referenciákat, vagy szembarát grafikát összekötő vonalakkal...

Utóbbira a SQuirreL graph pluginja megteszi (de ziher, hogy a grafikus sql kliensek között akad, ami szebben és jobban is végzi ezt).

A szöveges dokumentálásra OOB ötletem nincs, mert tizenpáréve nem nyúltam pg-hez. A DB2 a db-definíciót hajlandó táblaorientált LaTex forrásba nyomni, amit az ember kedvére átszabhat. Ha jobb nem akad, ezt az ötletet használnám fel itt is: megadni mindenhol objektumkommenteket, a metatáblákból lehúzni a megcélzott objektumok megcélzott tulajdonságait, és egy szkripttel kinyerni a LaTeX/XML/HTML dokot.

Szöveges dokumentációt szeretnék készíteni, mert van egy adatbázisom, és ha véletlenül valakit érdekel a dolog, akkor megkönnyítené a dolgát egy ilyen, és esetleg én sem filóznék két hónap múlva, hogy ezt miért így kellett. Tulajdonképpen a postgresql-autodoc is jó lehetne, ha legalább annyit meg lehetne tenni benne, hogy egy bármihez fűzött magyarázószövegben egy soremelést be tudnék szúrni, hogy ne egy bekezdés legyen az esetenként hosszabbra sikerült szöveg. Mert így egybehányva (minden soremelést, tab-ot kigyomlál) több helyen is rendkívül igénytelen és értelmezhetetlen az egész.

"This is a utility which will run through PostgreSQL system tables and returns HTML, DOT, and 2 styles of XML which describes the database.

The HTML is human readable (via webbrowser). The first style of XML is actually the fileformat of Dia, a UML diagram tool. The second type of XML is similar to the HTML but in the Docbook 4 format"

A fentiekből - vakrepülésben - azt veszem ki, hogy a megoldás a HTML-nek megfelelő break tagre, a dot-nak megfelelő "sor1\nsor2" formára, illetve valamelyik whitespace-tisztelő docbook környezetre átírásban van; attól függően, milyen fájlban jelenik meg a formázni kívánt szöveg.

Maximálisan egyetértünk, ill. egyetértenénk, csakhogy én kipróbáltam, nem megy.
Sokkal könnyebb kipróbálni néhány egyszerű dolgot, mint itt sírni, és válaszra várni, így általában ezt szoktam tenni.
Ettől függetlenül adtál ötletet, mert az autodoc forrásában (perl) megtaláltam azt a pár sort, ahol kigyomlálja a HTML tag-eket, ha ezt kiszedem/átírom talán jó lesz.
Persze inkább arra számítottam hogy esetleg a HUP űberszakijai közül valaki elárulja a titkot, hogy ezt a nagyok hogy csinálják. (Na jó, olyan nagyon azért nem számítottam rá.)