Document your tables and relationships

[MajP]

I added FAQ700-6905 to make it easier for people to describe their tables and relationshps. In order to get a good answer you often need to describe your table names, field names, field types, primary keys, foreign keys, and indices. This can take some time. The faq provides the code.

The procedure "documentTables" produces the following for all tables. The following example shows two tables:

datTblPersonnel
   autoPersonnelID   dbLong  PrimaryKey  Indexed
   txtSSN   dbText  Indexed
   strFirstName   dbText
   strLastName   dbText  Required
   strMiddleInitial   dbText
   strGender   dbText
   strService   dbText  Indexed
   intSubSectionID   dbLong  Indexed
   blnArchived   dbBoolean

joinTblPerson_StudyProj
   autoPerson_StudyProjID   dbLong  PrimaryKey  Indexed
   intFKeyPersonID   dbLong  ForiegnKey  Indexed
   intFKeyStudyProjID   dbLong  Indexed

The procedure "documentRelations" produces output like the following for all relationships.

Name: datTblPersonneljoinTblPerson_StudyProj
  Table: datTblPersonnel
  Foreign Table: joinTblPerson_StudyProj
  PK: autoPersonnelID   FK:intFKeyPersonID

Any comments or suggestions welcomed.

 

[jedraw]

MajP

Good stuff. Always looking for good tools to assist documentation.

Comment:

Description text for Table and Fields would be nice features.

 

[Ed2020]

jedraw,

Are you aware of MDBDoc (

http://mdbdoc.sourceforge.net/)?

Ed Metcalfe.

Please do not feed the trolls.....

 

[jedraw]

Ed,

Yes, I have been following some other materials on MDB documentation. I have seen your name in some.

I am aware of the mdb doc and also MZ_Tools (Other Utilities).

I think these would be great complementary products to what MajP has done.