diff --git a/README_SETUP.md b/README_SETUP.md index 211eaadf434198aa5c26fb339d4a61e185ee7527..7623cfa0f4a89c54575504ef94dd3f29379ae49a 100644 --- a/README_SETUP.md +++ b/README_SETUP.md @@ -7,7 +7,8 @@ ## Create the configuration * Create an empty `.config` file. For the default values and the meaning of - these default values see [config.defaults](config.defaults). For each + these default values see [config.defaults](https://gitlab.com/caosdb/caosdb-mysqlbackend/-/blob/main/config.defaults). + For each parameter that you want to change, add a corresponding line in your `.config` file. You probably want to change the passwords. As the passwords are stored unencrypted in the `.config` file, make sure nobody else can read it. diff --git a/doc/conf.py b/doc/conf.py index 72f154b48d83d6b01f825a75ba721fdd13a4575d..20f21f40728038c43e98725f6929bd1905d66dc6 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -69,7 +69,7 @@ master_doc = 'index' # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. diff --git a/doc/index.rst b/doc/index.rst index b621ddb98e914b2c4db1dd40bdb6453eb89a92fd..652b8556ca4cbbf29a6d29063e0d6d12d9b8b83e 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,6 +1,6 @@ Welcome to documentation of LinkAhead's MySQL Backend! -=================================================== +====================================================== .. toctree:: :maxdepth: 2 diff --git a/doc/table_structure.md b/doc/table_structure.md index 1641c568d18ec3fb87f60211aee816e6de049e7c..ce0eaacf05e5f887e2abdf56d75e31fc053dafca 100644 --- a/doc/table_structure.md +++ b/doc/table_structure.md @@ -85,12 +85,15 @@ The type of properties is stored here. The columns are: - `hash` :: Hash of the file contents, as binary. **TODO** Which algorithm? - `checked_timestamp` :: Timestamp when last checked? -## `feature_config` ## +## feature_config ## + +```sql +-------------------+---------+ | _key | _value | +-------------------+---------+ | ENTITY_VERSIONING | ENABLED | +-------------------+---------+ +``` A key-value store for features. Use the `is_feature_config` procedure to check for the status of specific features.