From fe504e33c9f4463e9c18867424814f5e8cee0be4 Mon Sep 17 00:00:00 2001 From: JohnE Date: Wed, 24 Feb 2016 10:38:16 -0800 Subject: [PATCH] NEW: add documentation for the index database --- docs/README_DEV_DB | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 docs/README_DEV_DB diff --git a/docs/README_DEV_DB b/docs/README_DEV_DB new file mode 100644 index 0000000..86394e2 --- /dev/null +++ b/docs/README_DEV_DB @@ -0,0 +1,30 @@ + ===================== + Fingerprint Index + ===================== + +------------- + INTRO +------------- +Why: +The purpose of the database fingerprint index is for speed and quick statistics. The +current number of fingerprints that I have created is ~ 180. In the future it likely +that our fingerprints will be > 1000. The index is designed for the future. + +Where: +A sqlite database (_index_dbfp.db) is populated with index data. The current design +expects the index file to be located in the same directory as all the fingerprints. + +How: +To create the index each fingerprint is read and unique hash values are inserted +into the index database along with the fingerprint file name. The current design +expects all fingerprint files to be in one dirctory. The fingerprint names are +created uniquely and should never have a collision. + + +------------------- + INDEX DB SCHEMA +------------------- + +The + +