------=_Part_8628738_1322156702.1361887395042 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit I think your idea is very good. I also think we should have it for columns as well. But since we already have many columns, maybe we should have an "on going effort" from various developers on this (i.e - each developer will do that for several tables). Thoughts? ----- Original Message -----
From: "Libor Spevak" <lspevak@redhat.com> To: engine-devel@ovirt.org Sent: Tuesday, February 26, 2013 2:37:17 PM Subject: [Engine-devel] Engine table comments
Hi, I would like to propose to create a patch assigning sql comment to each Engine table. The comments will be a part of the exported DB schema report, too. The terminology is not always consistent across all application layers, so for the newcomers it would be easier to understand the model.
But, what would be general guidelines?
I recommend to use singular form of entity name as used from end-user point of view (if somehow visible, of course), or just used frequently inside code.
Examples: storage_pool ... Data center vds_groups ... Cluster but: vm_static ... Virtual machine configuration vm_dynamic ... Virtual machine runtime data vm_statistics ... Virtual machine statistics data ... etc.
This command prepares a template for the patch:
psql engine -U postgres -c "select 'COMMENT ON TABLE ' || relname || ' IS ''TODO'';' sql from pg_stat_user_tables t WHERE schemaname='public' order by t.relname" > comments_to_do.sql
or just I can prepare a page on the wiki with table containing table names and volunteers :-) can propose simple understandable comments for known tables.
Is it useful?
Thanks.
Regards, Libor
_______________________________________________ Engine-devel mailing list Engine-devel@ovirt.org http://lists.ovirt.org/mailman/listinfo/engine-devel
------=_Part_8628738_1322156702.1361887395042 Content-Type: text/html; charset=utf-8 Content-Transfer-Encoding: quoted-printable <html><head><style type=3D'text/css'>p { margin: 0; }</style></head><body><= div style=3D'font-family: times new roman,new york,times,serif; font-size: = 12pt; color: #000000'>I think your idea is very good.<div>I also think we s= hould have it for columns as well.</div><div>But since we already have many= columns, maybe we should have an "on going effort" from various developers= on this (i.e - each developer will do that for several tables).</div><div>= Thoughts?</div><div><br><br><hr id=3D"zwchr"><blockquote style=3D"border-le= ft:2px solid rgb(16, 16, 255);margin-left:5px;padding-left:5px;color:#000;f= ont-weight:normal;font-style:normal;text-decoration:none;font-family:Helvet= ica,Arial,sans-serif;font-size:12pt;"><b>From: </b>"Libor Spevak" <lspev= ak@redhat.com><br><b>To: </b>engine-devel@ovirt.org<br><b>Sent: </b>Tues= day, February 26, 2013 2:37:17 PM<br><b>Subject: </b>[Engine-devel] Engine = table comments<br><br> =20 =20 =20 =20 Hi, <br> I would like to propose to create a patch assigning sql comment to each Engine table.<br> The comments will be a part of the exported DB schema report, too.<br> The terminology is not always consistent across all application layers, so for the newcomers it would be easier to understand the model.<br> <br> But, what would be general guidelines?<br> <br> I recommend to use singular form of entity name as used from end-user point of view (if somehow visible, of course), or just used frequently inside code.<br> <br> Examples:<br> storage_pool ... Data center<br> vds_groups ... Cluster<br> but:<br> vm_static ... Virtual machine configuration<br> vm_dynamic ... Virtual machine runtime data<br> vm_statistics ... Virtual machine statistics data<br> ...<br> etc.<br> <br> This command prepares a template for the patch:<br> <br> <i>psql engine -U postgres -c "select 'COMMENT ON TABLE ' || relname || ' IS ''TODO'';' sql from pg_stat_user_tables t WHERE schemaname=3D'public' order by t.relname" > comments_to_do.sql</i>= <i><br> </i><br> or just I can prepare a page on the wiki with table containing table names and volunteers :-) can propose simple understandable comments for known tables.<br> <br> Is it useful?<br> <br> Thanks.<br> <br> Regards,<br> Libor<br> =20 <br>_______________________________________________<br>Engine-devel mailing= list<br>Engine-devel@ovirt.org<br>http://lists.ovirt.org/mailman/listinfo/= engine-devel<br></blockquote><br></div></div></body></html> ------=_Part_8628738_1322156702.1361887395042--