4:37 a.m.
This is a multi-part message in MIME format.
--------------090900020406030601070406
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit
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
--------------090900020406030601070406
Content-Type: text/html; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit
<html>
<head>
<meta http-equiv="content-type" content="text/html;
charset=ISO-8859-1">
</head>
<body bgcolor="#FFFFFF" text="#000000">
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='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>
</body>
</html>
--------------090900020406030601070406--