zii/DBFS
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fixed up the documentation and moved the README to the root dir for

Browse Source 
better repository support.
This commit is contained in:
Maurice ONeal 2022-07-10 08:55:04 -04:00
parent b66c2b92ab
commit 1caf9d309f
3 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/README.md → README.md
View File

@ -1,6 +1,6 @@
# DBFS # # DBFS #
(Database Filesystem) DBFS is a FUSE file system utilizing an SQL database as the file system's backend. It mimics regular block storage in database tables, storing hash values of each block and maintains uniqueness among these blocks using those hash vaules. As a result, this file system can theorically store more data while utilizing less actual data storage space. Other benefits include fast/easy snapshotting, forking and indexing. (Database Filesystem) DBFS is a FUSE file system utilizing an SQL database as the file system's backend. It mimics regular block storage in database tables, storing hash values of each block and maintains uniqueness among these blocks using those hash values. As a result, this file system can theoretically store more data while utilizing less actual data storage space. Other benefits include fast/easy snapshot-ting, forking and indexing.
### Usage ### ### Usage ###
@ -22,14 +22,14 @@ Arguments>
--config <path-to-json-file> --config <path-to-json-file>
Use this option to point to a json formatted file to Use this option to point to a json formatted file to
configure the application's behaviour upon mounting the configure the application's behavior upon mounting the
database file system. If not present, it will use the database file system. If not present, it will use the
default config file location. default config file location.
--config_help --config_help
Display details about the json config file and the Display details about the json config file and the
various elements it uses to change application behaviour. various elements it uses to change application behavior.
--list_db_drvs --list_db_drvs
@ -52,7 +52,7 @@ gcc
make make
python3 python3
``` ```
Note: At this time, this application only supports linux based platforms. Note: At this time, this application only supports Linux based platforms.
### Build ### ### Build ###
@ -62,7 +62,7 @@ while running the install script, it will ask you to input 1 of 3 options:
***local machine*** - This option will install the built application onto the local machine without creating an installer. ***local machine*** - This option will install the built application onto the local machine without creating an installer.
***create installer*** - This option creates an installer that can be distributed to other machines for installation. The resulting installer is just a regular .py script file that the target machine can run if it has Python3 insalled. Only Python3 needs to be installed and an internet connection is not required. ***create installer*** - This option creates an installer that can be distributed to other machines for installation. The resulting installer is just a regular .py script file that the target machine can run if it has Python3 installed. Only Python3 needs to be installed and an internet connection is not required.
***exit*** - Cancel the installation. ***exit*** - Cancel the installation.

2
docs/CONFIG.txt
View File

@ -71,5 +71,5 @@ Elements:
read_only read_only
This parameter is a bool value that tells the application This parameter is a bool value that tells the application
to mount the filesystem in read only mode regaurdless if to mount the filesystem in read only mode regardless if
you're mounting a snapshot dataset or not. you're mounting a snapshot dataset or not.

14
docs/HELP.txt
View File

@ -13,11 +13,11 @@
--blk-size <numeric-value-in-bytes> --blk-size <numeric-value-in-bytes>
Use this option along --run if initializing the filesystem Use this option along --run if initializing the filesystem
for the first time. this parameter will adjust the block for the first time. this parameter will adjust the block
size of the file system. The smaller the blk_size, the size of the file system. The smaller the blk_size, the
greater the compression effect will take hold; however, greater the compression effect will take hold; however,
with that comes higher overhead because more hash values with that comes higher overhead because more hash values
will need to be calculated per file and more blocks per will need to be calculated per file and more blocks per
file read will need to be fetched. This is ignored if a file read will need to be fetched. This is ignored if a
filesystem already exist in the database, it will instead filesystem already exist in the database, it will instead
use the blk_size value already stored in the database. use the blk_size value already stored in the database.
@ -26,14 +26,14 @@
--config <path-to-json-file> --config <path-to-json-file>
Use this option to point to a json formatted file to Use this option to point to a json formatted file to
configure the application's behaviour upon mounting the configure the application's behavior upon mounting the
database file system. If not present, it will use the database file system. If not present, it will use the
default config file location. default config file location.
--config-help --config-help
Display details about the json config file and the Display details about the json config file and the
various elements it uses to change application behaviour. various elements it uses to change application behavior.
--list-db-drvs --list-db-drvs