How to describe the basic information of a data table ?, Description Basic Information

How to describe the basic information of a data table ?, Description Basic Information

Recently, I have worked with a colleague to design database tables. After designing each table, we need to record the basic information of the table and send it to colleagues in the same project team for reference and review. At the beginning, we were not very clear about how to describe the information of each table. After discussing with you, we think it is appropriate to describe the basic information of the database table in the following format. This article is for reference by developers with similar requirements.

To fully describe a data table, you need to clarify these five parts: General description, version description, table structure description, table creation script, and initialization statement. The following uses the employee information table as an example:

1. General description (Table Storage Data Description and modules used)

Employee info table tb_employeeinfo, which defines the basic information that each employee stores in the database.

Usage module: employee information storage and processing module.

 

2. Version description (which baseline version is added and who is added)

XXX is added based on V1.01.01.

 

3. Table Structure Description (the field must be specified as the primary key)

Employee info table tb_employeeinfo

Field name	Data Type	Empty or not	Field description
Employeeno	Varchar2 (20)	N	Employee ID, which creates a unique index on this field
Employeename	Varchar2 (50)	N	Employee name
Employeeage	Int	N	Employee age
Employeeaddr	Varchar2 (100)	Y	Employee address

 

4. Table creation script (implemented based on OEACLE database)

5. Initialization statement

Initially, only the information of one employee is stored. The initial statement is as follows: