ykskb / phrag-standalone

Stand-alone Version of Phrag

Standalone Phrag

Stand-alone Version of Phrag

Instantly runnable: artifacts in this repository can be useful if GraphQL is desired for an RDBMS without any authentication or customization. They are also suitable for just playing around with Phrag.

For customization use cases, please refer to Phrag library.

Run

As a docker container

Run with self-contained database:

docker run -it -p 3000:3000 ykskb/phrag-standalone:latest

Run with JDBC URL to a custom SQLite DB:

docker run -it -p 3000:3000 \
-v /host/db/dir:/database \
-e JDBC_URL=jdbc:sqlite:/database/db.sqlite \
ykskb/phrag-standalone:latest

Notes:

• A host directory is mounted with -v so docker container can access the SQLite file.
• Full paths should be used for volume mounting. Please refer to Docker documentation for details.

Run with a custom PostgreSQL DB:

docker run -it -p 3000:3000 \
-e DB_CURRENT_SCHEMA=public \
-e DB_HOST=your.db.host \
-e DB_NAME=mydb \
-e DB_PASSWORD=mysecret \
-e DB_PORT=5432 \
-e DB_TYPE=postgresql \
-e DB_USER=mydbuser \
ykskb/phrag-standalone:latest

Notes:

• If PostgreSQL is running in host, host.docker.internal can be used to connect from a docker container in Mac and Windows.
• To stop a running container of Phrag, simply press CTRL + C.

As a Java process

Build jar file:

# Clone & cd into this repository and run:
lein uberjar

Run:

# Set env vars for DB connection and run:
java -jar target/phrag-standalone-0.1.0-standalone.jar

Notes:

To stop a running Java process of Phrag, simply press CTRL + C.

Environment Variables

Env vars for a database connection can be provided to docker container or Java process.

If no variable is provided, Phrag process connects to a self-contained SQLite DB by default.

• JDBC_URL: if a JDBC connection URL is provided, it'll supersede all other env vars below.

• DB_TYPE: a database type such as postgresql.

• DB_HOST: a host of a database.

• DB_PORT: a port of a database.

• DB_USER: a database user.

• DB_PASSWORD: a password for the database user.

• DB_CURRENT_SCHEMA: a current schema for PostgreSQL database. Typically public.