Same filename in this branch
- 5.x sites/all/README.txt
- 5.x developer/database/README.txt
This folder contains some preliminary documentation for the Drupal database.
Please note that these files are NOT complete! This spot is for us to
have a working place to centralize database documentation efforts. If you
spot errors, or would like to help with the documentation effort, please
contact hlslaughter or webchick.
* annotated_database.mysql:
A copy of database.mysql from Drupal HEAD which contains comments
describing where the PK and FK relationships are. The plan is to
eventually extend this to also contain comments on what each
table/field is for, and (possibly) have this file replace the existing
database.mysql file in Drupal core so the schema is documented out of
the box.
* annotated_database.4.1.mysql
Similar to above, but based on 4.7 schema version and with a different
style of documentation.
* data_dictionary.html:
A complete data dictionary for Drupal core's database. At the moment,
this contains only relationship info, but will eventually be expanded
to show comments on what each field is for as well.
* database.xml (coming soon)
An E-R diagram of the Drupal database in XML format (generated from
DBDesigner).
* drupal_pma_relation.sql:
A dump of the pma_relation table from PHPMyAdmin, which establishes
the relations between the tables without the use for foreign keys.
Only required if you intend to make changes to the documentation of
relationships between tables (source database is called "drupal_head").
File
developer/database/README.txt
View source
-
- This folder contains some preliminary documentation for the Drupal database.
-
- Please note that these files are NOT complete! This spot is for us to
- have a working place to centralize database documentation efforts. If you
- spot errors, or would like to help with the documentation effort, please
- contact hlslaughter or webchick.
-
- * annotated_database.mysql:
- A copy of database.mysql from Drupal HEAD which contains comments
- describing where the PK and FK relationships are. The plan is to
- eventually extend this to also contain comments on what each
- table/field is for, and (possibly) have this file replace the existing
- database.mysql file in Drupal core so the schema is documented out of
- the box.
-
- * annotated_database.4.1.mysql
- Similar to above, but based on 4.7 schema version and with a different
- style of documentation.
-
- * data_dictionary.html:
- A complete data dictionary for Drupal core's database. At the moment,
- this contains only relationship info, but will eventually be expanded
- to show comments on what each field is for as well.
-
- * database.xml (coming soon)
- An E-R diagram of the Drupal database in XML format (generated from
- DBDesigner).
-
- * drupal_pma_relation.sql:
- A dump of the pma_relation table from PHPMyAdmin, which establishes
- the relations between the tables without the use for foreign keys.
- Only required if you intend to make changes to the documentation of
- relationships between tables (source database is called "drupal_head").