https://github.com/codbex/codbex-hades
Database Management Platform
https://github.com/codbex/codbex-hades
platform
Last synced: 2 months ago
JSON representation
Database Management Platform
- Host: GitHub
- URL: https://github.com/codbex/codbex-hades
- Owner: codbex
- License: epl-2.0
- Created: 2022-11-05T05:56:35.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-01-21T15:40:08.000Z (3 months ago)
- Last Synced: 2026-01-22T02:30:06.903Z (3 months ago)
- Topics: platform
- Language: Java
- Homepage: https://codbex.com
- Size: 557 KB
- Stars: 1
- Watchers: 7
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hades by codbex
[](https://github.com/codbex/codbex-hades/actions/workflows/build.yaml)
[](https://github.com/codbex/codbex-hades/blob/main/LICENSE)
[](https://central.sonatype.com/namespace/com.codbex.hades)
Hades Edition contains database management standard components.
It is good for exploration the database instances, schemes and artefacts. It is also capable of exporting, importing and
transferring data sets.
* [Hades by codbex](#hades-by-codbex)
* [Run steps](#run-steps)
* [Start using Docker and released image](#start-using-docker-and-released-image)
* [Start using Docker and local sources](#start-using-docker-and-local-sources)
* [Build the project jar](#build-the-project-jar)
* [Build and run docker image locally](#build-and-run-docker-image-locally)
* [Java standalone application](#java-standalone-application)
* [Start the application](#start-the-application)
* [Start the application **in debug** with debug port
`8000`](#start-the-application-in-debug-with-debug-port-8000)
* [Spring profiles](#spring-profiles)
* [Run unit tests](#run-unit-tests)
* [Run integration tests](#run-integration-tests)
* [Run all tests](#run-all-tests)
* [Format the code](#format-the-code)
* [Access the application](#access-the-application)
* [REST API](#rest-api)
* [Configuration Options](#configuration-options)
* [Datasources](#datasources)
* [Memory](#memory)
* [Log Levels](#log-levels)
* [Timeouts](#timeouts)
* [Limits](#limits)
## Run steps
__Prerequisites:__
- Export the following variables before executing the steps
```shell
export GIT_REPO_FOLDER=''
export IMAGE='ghcr.io/codbex/codbex-hades:latest'
export CONTAINER_NAME='hades'
```
### Start using Docker and released image
```shell
# optionally remove the existing container with that name
docker rm -f "$CONTAINER_NAME"
docker pull "$IMAGE"
docker run --name "$CONTAINER_NAME" -p 80:80 "$IMAGE"
```
---
### Start using Docker and local sources
#### Build the project jar
```shell
cd $GIT_REPO_FOLDER
mvn -T 1C clean install -P quick-build
```
#### Build and run docker image locally
__Prerequisites:__ [Build the project jar](#build-the-project-jar)
```shell
cd "$GIT_REPO_FOLDER/application"
docker build . --tag "$IMAGE"
# optionally remove the existing container with that name
docker rm -f "$CONTAINER_NAME"
docker run --name "$CONTAINER_NAME" -p 80:80 "$IMAGE"
```
---
### Java standalone application
__Prerequisites:__ [Build the project jar](#build-the-project-jar)
#### Start the application
```shell
cd "$GIT_REPO_FOLDER"
java \
--add-opens=java.base/java.lang=ALL-UNNAMED \
--add-opens=java.base/java.lang.reflect=ALL-UNNAMED \
--add-opens=java.base/java.nio=ALL-UNNAMED \
-jar application/target/codbex-hades-*.jar
```
#### Start the application **in debug** with debug port `8000`
```shell
cd "$GIT_REPO_FOLDER"
export PHOEBE_AIRFLOW_WORK_DIR="$AIRFLOW_WORK_DIR"
java \
-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000 \
--add-opens=java.base/java.lang=ALL-UNNAMED \
--add-opens=java.base/java.lang.reflect=ALL-UNNAMED \
--add-opens=java.base/java.nio=ALL-UNNAMED \
-jar application/target/codbex-hades-*.jar
```
#### Spring profiles
- Eclipse Dirigible profiles
To activate Eclipse Dirigible, you have to add profiles `common` and `app-default` explicitly.
Example for profile `snowflake`: `SPRING_PROFILES_ACTIVE=common,snowflake,app-default`
---
### Run unit tests
```shell
cd "$GIT_REPO_FOLDER"
mvn clean install -P unit-tests
```
---
### Run integration tests
```shell
cd "$GIT_REPO_FOLDER"
mvn clean install -P integration-tests
```
---
### Run all tests
```shell
cd "$GIT_REPO_FOLDER"
mvn clean install -P tests
```
---
### Format the code
```shell
cd "$GIT_REPO_FOLDER"
mvn verify -P format
```
---
## Access the application
- Open URL [http://localhost:80](http://localhost:80)
- Login with the default credentials username `admin` and password `admin`
## REST API
```
http://localhost/swagger-ui/index.html
```
#### Configuration Options
##### Datasources
DIRIGIBLE_DATABASE_CUSTOM_DATASOURCES=MYDB1,MYDB2
MYDB1_DRIVER=(JDBC driver)
MYDB1_URL=(URL depending on the JDBC driver format)
MYDB1_USERNAME=(base64 encoded username)
MYDB1_PASSWORD=(base64 encoded password)
MYDB2_DRIVER=...
##### Memory
JAVA_TOOL_OPTIONS="-XX:MinRAMPercentage=80.0 -XX:MaxRAMPercentage=90.0"
##### Log Levels
logging.level.org.springframework=DEBUG
logging.level.org.eclipse.dirigible=DEBUG
##### Timeouts
spring.datasource.hikari.connectionTimeout="3600000"
spring.mvc.async.request-timeout="3600000"
##### Limits
DIRIGIBLE_DATABASE_DEFAULT_QUERY_LIMIT="10000000"