Oracle FAQ Your Portal to the Oracle Knowledge Grid
HOME | ASK QUESTION | ADD INFO | SEARCH | E-MAIL US
 

Home -> Community -> Mailing Lists -> Oracle-L -> Re: Documenting databases

Re: Documenting databases

From: <Kip.Bryant_at_Vishay.com>
Date: Tue, 09 Dec 2003 17:24:24 -0800
Message-ID: <F001.005D9546.20031209172424@fatcity.com> 





Don't know if this has been mentioned or if it does enough of what you're 
looking for but you can pick up something called "RDA" (remote diagnostic 
agent) from Oracle that'll give you an overview of OS setup, Network, 
performance (very high level), and RDBMS info.  And the result is web-a-fied 
which might please your manager. I forget whether I found this in metalink or 
technet...



Kip




|The internal stuff can be documented with OraSnap.




|Just google for it.  It's free, detailed, and easy to setup and automate.




|Jared









|alan.aschenbrenner_at_ihs.com

|Sent by: ml-errors_at_fatcity.com

| 12/09/2003 03:34 PM

| Please respond to ORACLE-L


 


|        To:     Multiple recipients of list ORACLE-L <ORACLE-L_at_fatcity.com>

|        cc:

|        Subject:        Re: Documenting databases









|Dan,




|    That's a good idea for documenting structures inside the database.

|However, my database manager wants more high level info:  database name /

|host, oracle version, listeners, applications that use it, cron job

|descriptions and times, main schemas and what they are used for, lists of

|developers names that access the databse, etc...




|Alan




  


|                      Daniel Hanks

|                      <hanksdc_at_about-in        To:       Multiple

|recipients of list ORACLE-L <ORACLE-L_at_fatcity.com>

|                      c.com>                   cc:

|                      Sent by:                 Subject:  Re: Documenting

|databases

|                      ml-errors_at_fatcity

|                      .com

  
  


|                      12/09/2003 04:09

|                      PM

|                      Please respond to

|                      ORACLE-L


  
  






|On Tue, 9 Dec 2003 alan.aschenbrenner_at_ihs.com wrote:




|>     Recently our database manager has asked us to do the unthinkable....

|> document our databases!  To make matters worse, and without our input,

|he

|> went ahead and created a schema and put it in an Access database (using

|> tables to make it look like a speadsheet).  Either we use his idea or

|come

|> up with something else.

|>     So, I thought I'd ask everyone on the list how you do it.  Text

|files?

|> In a database (oracle, or other)?   Spreadsheets?  What are the pros and

|> cons?  Etc....

|>




|How about in each database itself.




|COMMENT ON TABLE|COLUMN tab|tab.col IS '...'




|comes to mind. It's simplistic, yes, but at least you don't have to

|remember where you put your documentation...




|HTH,





|-- Dan

|========================================================================

|   Daniel Hanks - Systems/Database Administrator

|   About Inc., Web Services Division

|========================================================================

|--

|Please see the official ORACLE-L FAQ: http://www.orafaq.net

|--

|Author: Daniel Hanks

|  INET: hanksdc_at_about-inc.com




|Fat City Network Services    -- 858-538-5051 http://www.fatcity.com

|San Diego, California        -- Mailing list and web hosting services

|---------------------------------------------------------------------

|To REMOVE yourself from this mailing list, send an E-Mail message

|to: ListGuru_at_fatcity.com (note EXACT spelling of 'ListGuru') and in

|the message BODY, include a line containing: UNSUB ORACLE-L

|(or the name of mailing list you want to be removed from).  You may

|also send the HELP command for other information (like subscribing).






|--

|Please see the official ORACLE-L FAQ: http://www.orafaq.net

|--

|Author:

|  INET: alan.aschenbrenner_at_ihs.com




|Fat City Network Services    -- 858-538-5051 http://www.fatcity.com

|San Diego, California        -- Mailing list and web hosting services

|---------------------------------------------------------------------

|To REMOVE yourself from this mailing list, send an E-Mail message

|to: ListGuru_at_fatcity.com (note EXACT spelling of 'ListGuru') and in

|the message BODY, include a line containing: UNSUB ORACLE-L

|(or the name of mailing list you want to be removed from).  You may

|also send the HELP command for other information (like subscribing).





Content-type: text/html; charset=us-ascii



<br><font size=2 face="sans-serif">The internal stuff can be documented with OraSnap.</font>
<br>
<br><font size=2 face="sans-serif">Just google for it. &nbsp;It's free, detailed, and easy to setup and automate.</font>
<br>
<br><font size=2 face="sans-serif">Jared</font>
<br><font size=2 face="sans-serif"><br>
</font>
<br>
<br>
<br>
<table width=100%>
<tr valign=top>
<td>
<td><font size=1 face="sans-serif"><b>alan.aschenbrenner_at_ihs.com</b></font>
<br><font size=1 face="sans-serif">Sent by: ml-errors_at_fatcity.com</font>
<p><font size=1 face="sans-serif">&nbsp;12/09/2003 03:34 PM</font>
<br><font size=2 face="sans-serif">&nbsp;</font><font size=1 face="sans-serif">Please respond to ORACLE-L</font>
<br>
<td><font size=1 face="Arial">&nbsp; &nbsp; &nbsp; &nbsp; </font>
<br><font size=1 face="sans-serif">&nbsp; &nbsp; &nbsp; &nbsp; To: &nbsp; &nbsp; &nbsp; &nbsp;Multiple recipients of list ORACLE-L &lt;ORACLE-L_at_fatcity.com&gt;</font>
<br><font size=1 face="sans-serif">&nbsp; &nbsp; &nbsp; &nbsp; cc: &nbsp; &nbsp; &nbsp; &nbsp;</font>
<br><font size=1 face="sans-serif">&nbsp; &nbsp; &nbsp; &nbsp; Subject: &nbsp; &nbsp; &nbsp; &nbsp;Re: Documenting databases</font></table>
<br>
<br>
<br><font size=2 face="Courier New"><br>
<br>
<br>
<br>




Dan,<br>


<br>


 &nbsp; &nbsp;That's a good idea for documenting structures inside the database.<br>
However, my database manager wants more high level info: &nbsp;database name /<br>
host, oracle version, listeners, applications that use it, cron job<br>
descriptions and times, main schemas and what they are used for, lists of<br>
developers names that access the databse, etc...<br>
<br>


Alan<br>

<br>
<br>
<br>
 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <br>
 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;Daniel Hanks &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <br>
 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&lt;hanksdc_at_about-in &nbsp; &nbsp; &nbsp; &nbsp;To: &nbsp; &nbsp; &nbsp; Multiple recipients of list ORACLE-L &lt;ORACLE-L_at_fatcity.com&gt; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <br>
 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;c.com&gt; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; cc: &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <br>
 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;Sent by: &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; Subject: &nbsp;Re: Documenting databases &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <br>
 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;ml-errors_at_fatcity &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<br>
 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;.com &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <br>
 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <br>
 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <br>
 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;12/09/2003 04:09 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <br>
 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;PM &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <br>
 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;Please respond to &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<br>
 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;ORACLE-L &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <br>


 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <br>
 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <br>

<br>
<br>
<br>
<br>




On Tue, 9 Dec 2003 alan.aschenbrenner_at_ihs.com wrote:<br>
<br>

&gt; &nbsp; &nbsp; Recently our database manager has asked us to do the unthinkable....<br>
&gt; document our databases! &nbsp;To make matters worse, and without our input, he<br>
&gt; went ahead and created a schema and put it in an Access database (using<br>
&gt; tables to make it look like a speadsheet). &nbsp;Either we use his idea or<br>


come<br>


&gt; up with something else.<br>


&gt; &nbsp; &nbsp; So, I thought I'd ask everyone on the list how you do it. &nbsp;Text<br>
files?<br>

&gt; In a database (oracle, or other)? &nbsp; Spreadsheets? &nbsp;What are the pros and<br>
&gt; cons? &nbsp;Etc....<br>
&gt;<br>




<br>


How about in each database itself.<br>


<br>


COMMENT ON TABLE|COLUMN tab|tab.col IS '...'<br>
<br>


comes to mind. It's simplistic, yes, but at least you don't have to<br>
remember where you put your documentation...<br>
<br>


HTH,<br>


<br>


-- Dan<br>

========================================================================<br>


 &nbsp; Daniel Hanks - Systems/Database Administrator<br>
 &nbsp; About Inc., Web Services Division<br>

========================================================================<br>


--<br>


Please see the official ORACLE-L FAQ: http://www.orafaq.net<br>
--<br>


Author: Daniel Hanks<br>


 &nbsp;INET: hanksdc_at_about-inc.com<br>


<br>

Fat City Network Services &nbsp; &nbsp;-- 858-538-5051 http://www.fatcity.com<br>
San Diego, California &nbsp; &nbsp; &nbsp; &nbsp;-- Mailing list and web hosting services</font>
<br><font size=2 face="Courier New">---------------------------------------------------------------------<br>


To REMOVE yourself from this mailing list, send an E-Mail message<br>
to: ListGuru_at_fatcity.com (note EXACT spelling of 'ListGuru') and in<br>
the message BODY, include a line containing: UNSUB ORACLE-L<br>
(or the name of mailing list you want to be removed from). &nbsp;You may<br>
also send the HELP command for other information (like subscribing).<br>

<br>
<br>
<br>




-- <br>


Please see the official ORACLE-L FAQ: http://www.orafaq.net<br>
-- <br>


Author: <br>


 &nbsp;INET: alan.aschenbrenner_at_ihs.com<br>
<br>

Fat City Network Services &nbsp; &nbsp;-- 858-538-5051 http://www.fatcity.com<br>
San Diego, California &nbsp; &nbsp; &nbsp; &nbsp;-- Mailing list and web hosting services<br>
---------------------------------------------------------------------<br>


To REMOVE yourself from this mailing list, send an E-Mail message<br>
to: ListGuru_at_fatcity.com (note EXACT spelling of 'ListGuru') and in<br>
the message BODY, include a line containing: UNSUB ORACLE-L<br>
(or the name of mailing list you want to be removed from). &nbsp;You may<br>
also send the HELP command for other information (like subscribing).<br>

</font>
<br>
<br>




-- 
Please see the official ORACLE-L FAQ: http://www.orafaq.net
-- 
Author: 
  INET: Kip.Bryant_at_Vishay.com

Fat City Network Services    -- 858-538-5051 http://www.fatcity.com
San Diego, California        -- Mailing list and web hosting services
---------------------------------------------------------------------
To REMOVE yourself from this mailing list, send an E-Mail message
to: ListGuru_at_fatcity.com (note EXACT spelling of 'ListGuru') and in
the message BODY, include a line containing: UNSUB ORACLE-L
(or the name of mailing list you want to be removed from).  You may
also send the HELP command for other information (like subscribing).


Received on Tue Dec 09 2003 - 19:24:24 CST












Original text of this message













  HOME |
  ASK QUESTION |
  ADD INFO |
  SEARCH |
  E-MAIL US