j3g
/
dbfp_pub
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

NEW: add documentation for the index database

This commit is contained in:
JohnE 2016-02-24 10:38:16 -08:00
parent 39408902a7
commit fe504e33c9
1 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/README_DEV_DB Normal file
View File

@ -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