aboutsummaryrefslogtreecommitdiff
path: root/sql/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'sql/README.md')
-rw-r--r--sql/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/sql/README.md b/sql/README.md
new file mode 100644
index 0000000..2f93d1c
--- /dev/null
+++ b/sql/README.md
@@ -0,0 +1,9 @@
+# MariaDB setup
+
+This directory hosts any new SQL table added to genenetwork3. When preparing
+statements, be sure to follow [this](https://www.sqlstyle.guide/) style guide.
+
+Also, not that in some tables, we use the json data format; therefore make
+sure you have MariaDB version 10.2 and later which include a range of JSON
+supporting functions. Read about that
+[here](https://mariadb.com/resources/blog/json-with-mariadb-10-2/)