How to Build a Relational Database Dictionary
A data dictionary provides information about the data, tables and other elements of a relational database for users, developers and administrators to refer to when using the database. The data dictionary describes each table and field, listing keys, indexes and other relevant information so users can understand how your relational database is structured and how to access the information it contains. The simplest way to build a data dictionary is to create a document that organizes the information in a table.
Instructions
-
-
1
Create a table for the data fields with columns labeled "Table," "Field Name," "Type," "Size," "Required" and "Description."
-
2
List every field (column) in the database in the "Field Name" column.
-
-
3
List the name of the table each field is stored in in the "Table" column.
-
4
Provide the field data type (integer, varchar, text, date, etc.) in the "Type" column. Add the size in the "Size" column for varchar and other types that have a size restriction.
-
5
Add a "Y" to the "Required" column for each field that does not allow null or empty values.
-
6
Write a description for each field in the "Description" column. Provide useful information about what the field content means, expected value, format and so forth.
-
7
Add and fill in additional columns as needed to describe your data. For example, you may want to list the possible values for enumerations, restrictions for numbers that have minimum and maximum values, units for numerical values that have units (meters, degrees, etc.).
-
8
Create a new table for the database tables with columns labeled "Table Name," "Indexes," "Primary Key(s)," "Foreign Keys" and "Description." If you are using a spreadsheet, create the table on a new worksheet.
-
9
List every database table name in the "Table Name" column.
-
10
List the indexes and keys in the appropriate columns.
-
11
Write a description for each table in the "Description" column. Provide useful information about what general type of information is stored in the table, how the table is used, its relationship to other tables, etc.
-
12
Add and fill in additional columns as needed to describe your database tables. For example, list functions and triggers, table storage type and any additional information that your users need to know when using your database.
-
13
Save your document and share with it others as appropriate.
-
1
References
Resources
Comments
-
alisonjuli10
Oct 19, 2010
Tech Tron has accumulated years of cross-industry expertise in database design, database development and programming, database integration and conversion, database management and administration, database maintenance and support.