aboutsummaryrefslogtreecommitdiff
path: root/sql
diff options
context:
space:
mode:
authorArun Isaac2021-07-31 18:15:30 +0530
committerArun Isaac2021-07-31 18:15:30 +0530
commit234dafc293b2a4a0f85c83cdd2253a9b9e57a74e (patch)
tree3c1c16ece8aad1b1f5a8784f1420dbdc96dc6814 /sql
parent00278bc237c90b4ac276171a32bbe57e056644b6 (diff)
downloadgenenetwork3-234dafc293b2a4a0f85c83cdd2253a9b9e57a74e.tar.gz
sql: Add schema description.
* sql/schema.org: New file.
Diffstat (limited to 'sql')
-rw-r--r--sql/schema.org26
1 files changed, 26 insertions, 0 deletions
diff --git a/sql/schema.org b/sql/schema.org
new file mode 100644
index 0000000..0d0646f
--- /dev/null
+++ b/sql/schema.org
@@ -0,0 +1,26 @@
+#+TITLE: GeneNetwork Database Schema
+
+This is an attempt to reverse engineer and understand the schema of the
+GeneNetwork database. The goal is to prune redundant tables, fields, etc. and
+arrive at a simplified schema. This simplified schema will be useful when
+migrating the database.
+
+* Species
+** Id
+ Primary key
+** SpeciesId
+ Looks like a redundant key referred to as a foreign key from many other
+ tables. This field should be replaced by Id.
+** SpeciesName
+ Common name of the species. This field can be replaced by MenuName.
+** Name
+ Downcased common name used as key for the species in dictionaries
+** MenuName
+ Name in the Species dropdown menu. This is the SpeciesName, but sometimes
+ with the reference genome identifier mentioned in brackets.
+** FullName
+ Binomial name of the species
+** TaxonomyId
+ Foreign keys?
+** OrderId
+ Foreign keys?