View on GitHub

JODA - JSON On Demand Analysis

Efficient data wrangling for semi-structured JSON documents

To install JODA you can choose between the following options:

Docker

The easiest way to install JODA is to use public Docker images. The main image contains the JODA executable and JODA-client program. An additional image is available for the JODA web interface. The images can be found in the GitHub container repository:

Starting a JODA server is as simple as running the image:

docker run -p 5632:5632 --name joda ghcr.io/joda-explore/joda/joda:latest 

This will start a JODA server listening on port 5632. To interface with the server, you can either use the CLI client tool, which can only execute queries, by running:

docker exec -it joda joda-client --address localhost --port 5632

If no server is needed and only local execution is required, JODA can also be started as a standalone CLI:

docker run -it ghcr.io/joda-explore/joda/joda:latest -c

You are now in a JODA shell. Type help; to get a list of available commands.

JODA Web

The best and easiest way to interact with JODA is to use the web interface. The following docker-compose file will start a JODA server and a web interface:

version: '3'
services:
  joda:
    container_name: joda
    restart: always
    ports:
      - "5632:5632"
    volumes:
#     - <Path-To-Data-Firectory>:/data:rw  # Optional directory, if access to local datasets is desired.
      - /etc/localtime:/etc/localtime:ro
    image: ghcr.io/joda-explore/joda/joda:latest
  joda-web:
    container_name: joda-web
    restart: always
    ports:
      - "8080:8080"
    image: ghcr.io/joda-explore/joda-web:latest
    depends_on:
      - joda
    command: "http://joda:5632"

The web interface can now be accessed at http://localhost:8080. Refer to the Getting Started page for further instructions on using the interface.

Packages

Native packages for JODA are available for Ubuntu and Debian distributions on the release page. To install the packages, run:

sudo apt install <Joda-Package>.deb

This will install the joda and joda-client executables on your system.

Compiling

If you are using another system, you can compile the JODA binaries yourself. JODA currently only supports Linux systems. Before you can compile JODA, you have to install the following dev-dependencies:

For optional support for FROM URL imports, the following packages are also required:

Please refer to your system’s package manager for the exact package names.

To compile and install JODA, run:

git clone https://github.com/JODA-Explore/JODA
cd JODA
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
make -j$(nproc)
make install