diff --git a/README.md b/README.md index 7e7dd25ee4cfbb88ac93873cac512ae4eb2a0f2c..68e24bfa68906672c49e4dfc88c389c183ce07b4 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,41 @@ -# check-deegree-sql-ds - -Python script checks whether the database tables and columns referenced in a deegree SQL Feature Store configuration exist in a specific database and outputs the result in a log file. - -## Features -* Enables simple control of large projects when the database is modified -* Checks input data at syntax and schema level -* Ensures that no database connection remains open - - -## Usage -```powershell -python main.py --sql_fs 'FEATURE STORE' --db_connection 'DB CONNECTION' --logfile 'OUTPUT LOG' [--mode '[short|normal|debug]]'[--help] -``` - -## Parameters - -* `-s, --sql_fs`: Deegree Server SQL Feature Store Configuration (.xml). This file contains the mapping from the relational database structure of a PostgreSQL database to a GML schema. Its structure is described in the documentation of [deegree server](https://download.deegree.org/documentation/3.5.5/html/#anchor-configuration-sqlfeaturestore). -* `d, --db_connection`: JSON file containing the connection information for the PostgreSQL database. The corresponding JSON schema can be found under `./schema/database-config.json`. Example (`./input/database.json`): - ```json - { - "host": "127.0.0.1", - "port": 5432, - "databaseName": "postgres", - "user": "postgres", - "password": "postgres" - } - ``` - Note: The *password* key is optional. If it is not set, the password is requested via a user input. -* `-l, --logfile`: Log file for outputting the results. Missing tables and columns in the database are shown as warnings. -* `-m, --mode`: Output mode (optional). Possible Values are: - + *short*: Shows only warnings - + *normal*: default Value. Shows infos - * *debug*: verbose Output -## Changelog - -### 1.0.1 - -* Add additional command line parameter *mode* to control internal log level -* rename the command line parameter - +# check-deegree-sql-ds + +Python script checks whether the database tables and columns referenced in a deegree SQL Feature Store configuration exist in a specific database and outputs the result in a log file. + +## Features +* Enables simple control of large projects when the database is modified +* Checks input data at syntax and schema level +* Ensures that no database connection remains open + + +## Usage +```powershell +python main.py --sql_fs 'FEATURE STORE' --db_connection 'DB CONNECTION' --logfile 'OUTPUT LOG' [--mode '[short|normal|debug]'][--help] +``` + +## Parameters + +* `-s, --sql_fs`: Deegree Server SQL Feature Store Configuration (.xml). This file contains the mapping from the relational database structure of a PostgreSQL database to a GML schema. Its structure is described in the documentation of [deegree server](https://download.deegree.org/documentation/3.5.5/html/#anchor-configuration-sqlfeaturestore). +* `d, --db_connection`: JSON file containing the connection information for the PostgreSQL database. The corresponding JSON schema can be found under `./schema/database-config.json`. Example (`./input/database.json`): + ```json + { + "host": "127.0.0.1", + "port": 5432, + "databaseName": "postgres", + "user": "postgres", + "password": "postgres" + } + ``` + Note: The *password* key is optional. If it is not set, the password is requested via a user input. +* `-l, --logfile`: Log file for outputting the results. Missing tables and columns in the database are shown as warnings. +* `-m, --mode`: Output mode (optional). Possible Values are: + + *short*: Shows only warnings + + *normal*: default Value. Shows infos + * *debug*: verbose Output +## Changelog + +### 1.0.1 + +* Add additional command line parameter *mode* to control internal log level +* rename the command line parameter +