Update Settings authored by jvfpw18's avatar jvfpw18
# HOTMapper Settings # HOTMapper Settings
Updated with v1.0. Updated with v1.1.
This page contains information about HOTMapper Settings. This page contains information about HOTMapper Settings.
## Summary ## Summary
* [Login credentials in database (monetdb)](#login-credentials-in-database-monetdb) * [Login credentials in database (monetdb)](#login-credentials-in-database-monetdb)
* [Name of the database to connect to](#name-of-the-database-to-connect-to) * [Name of the database to connect to](#name-of-the-database-to-connect-to)
* [Temporal Column](#temporal-column)
* [Backup folder and file name](#backup-folder-and-file-name) * [Backup folder and file name](#backup-folder-and-file-name)
* [Source table definitions](#source-table-definitions) * [Source table definitions](#source-table-definitions)
* [Show SQL queries sent to database](#show-sql-queries-sent-to-database) * [Show SQL queries sent to database](#show-sql-queries-sent-to-database)
...@@ -26,6 +27,13 @@ In the `settings.py` file, present on the HOTMapper main folder, you'll encounte ...@@ -26,6 +27,13 @@ In the `settings.py` file, present on the HOTMapper main folder, you'll encounte
DATABASE = 'hotmapper_demo' DATABASE = 'hotmapper_demo'
~~~ ~~~
#### Temporal column.
If your table has a column that represents the temporal column(same used in the `mapping_protocol`), HOTMapper
will use it as a where clause when running aggregations and denormalizations.
~~~
YEAR_COLUMN = 'ano_censo'
~~~
#### Backup folder and file name #### Backup folder and file name
Absolute path of the folder where backup is created, name of the backup file. Absolute path of the folder where backup is created, name of the backup file.
~~~ ~~~
...@@ -33,6 +41,24 @@ In the `settings.py` file, present on the HOTMapper main folder, you'll encounte ...@@ -33,6 +41,24 @@ In the `settings.py` file, present on the HOTMapper main folder, you'll encounte
BACKUP_FILE = 'backupdadoseducacionais' BACKUP_FILE = 'backupdadoseducacionais'
~~~ ~~~
#### Mapping Protocols Folder
You can change where to store the mapping protocols CSV.
~~~
MAPPING_PROTOCOLS_FOLDER = 'mapping_protocols'
~~~
#### Table Definitions Folder
You can change where to store the table definitions JSON.
~~~
TABLE_DEFINITIONS_FOLDER = 'table_definitions'
~~~
#### Scripts folder
Folder which your sql, bash or python scripts are stored. Used as the default folder in the run_script, execute_sql_group and rebuild_group commands.
~~~
SCRIPTS_FOLDER = 'sql'
~~~
#### Source table definitions #### Source table definitions
During the creation of your first table, HOTMapper will also create a table to store information about the data During the creation of your first table, HOTMapper will also create a table to store information about the data
source of each table you create. Here you can define the name of this table and it's columns. source of each table you create. Here you can define the name of this table and it's columns.
... ...
......