haystacks

"haystacks" is Web based Database schema viewer.

Usage

Requirements

Java 8+

Required options

curl -L -o haystacks-assembly-<mysql|postgresql>-latest.jar \
  https://github.com/yo1000/haystacks/releases/download/v0.0.14/haystacks-assembly-<mysql|postgresql>-0.0.14.jar

java -jar haystacks-assembly-<mysql|postgresql>-latest.jar \
  --spring.datasource.url=jdbc:mysql://<host>:<port>/<database> \
  --spring.datasource.name=<schema> \
  --spring.datasource.username=<username> \
  --spring.datasource.password=<password>

All options

curl -L -o haystacks-assembly-<mysql|postgresql>-latest.jar \
  https://github.com/yo1000/haystacks/releases/download/v0.0.14/haystacks-assembly-<mysql|postgresql>-0.0.14.jar

java -jar haystacks-assembly-<mysql|postgresql>-latest.jar \
  --spring.datasource.url=jdbc:mysql://<Host>:<Port>/<Database> \
  --spring.datasource.name=<Schema> \
  --spring.datasource.username=<Username> \
  --spring.datasource.password=<Password> \
  --haystacks.note.file.store-location=<Notes Save file location> \
  --haystacks.note.file.create-on-missing=<File creation on missing: default(true)> \
  --haystacks.web.ssr=<Rendering mode: default(true)> \
  --haystacks.web.title=<Site title> \
  --haystacks.web.logo=<Header logo url by svg> \
  --haystacks.web.favicon=<Favicon url> \
  --haystacks.cache.enabled=<Table-outlines service caching: default(true)>

Quick Start (MySQL)

Launch binary

with external Database. (MySQL sakila database by Docker container)

docker run -d \
  --name mysql-sakila \
  -p 3306:3306 \
  thebinarypenguin/mysql-sakila:latest

curl -L -o haystacks-assembly-mysql-latest.jar \
  https://github.com/yo1000/haystacks/releases/download/v0.0.14/haystacks-assembly-mysql-0.0.14.jar

java -jar haystacks-assembly-mysql-latest.jar \
  --spring.datasource.url=jdbc:mysql://localhost:3306/sakila \
  --spring.datasource.name=sakila \
  --spring.datasource.username=root \
  --spring.datasource.password=sakila

Browse to http://localhost:8080

Launch from source

with embedded DEMO Database.

git clone https://github.com/yo1000/haystacks.git
cd haystacks

./mvnw clean install && \
./mvnw spring-boot:run \
  -pl haystacks-assemblies/haystacks-assembly-mysql \
  -P demo

Browse to http://localhost:8080

Quick Start (PostgreSQL)

Launch binary

with external Database. (PostgreSQL pagila database by Docker container)

docker run -d \
  --name pagila \
  -p 5432:5432 \
  mujz/pagila:latest

curl -L -o haystacks-assembly-postgresql-latest.jar \
  https://github.com/yo1000/haystacks/releases/download/v0.0.14/haystacks-assembly-postgresql-0.0.14.jar

java -jar haystacks-assembly-postgresql-latest.jar \
  --spring.datasource.url=jdbc:postgresql://localhost:5432/pagila \
  --spring.datasource.name=public \
  --spring.datasource.username=root \
  --spring.datasource.password=admin

Browse to http://localhost:8080

Launch from source

with embedded DEMO Database.

git clone https://github.com/yo1000/haystacks.git
cd haystacks

./mvnw clean install && \
./mvnw spring-boot:run \
  -pl haystacks-assemblies/haystacks-assembly-postgresql \
  -P demo

Browse to http://localhost:8080