Note: This file is written in Markdown and is best viewed with a Markdown viewer (e.g., GitHub, GitLab, VS Code, or a dedicated Markdown reader). Viewing it in a plain text editor may not render the formatting as intended.

Copyright (c) 2025 Software Tree

Gilhari Autoincrement Example

Demonstrates database-generated primary keys (autoincrement IDs) with Gilhari ORM

Gilhari is a Docker-compatible microservice framework that provides RESTful Object-Relational Mapping (ORM) functionality for JSON objects with any relational database.

Remarkably, Gilhari automates REST APIs (POST, GET, PUT, DELETE, etc.) handling, JSON CRUD operations, and database schema setup — no manual coding required.

About This Example

This repository contains a standalone example showing how to configure Gilhari to use database-generated primary keys for JSON objects, eliminating the need for clients to specify ID values.

The example uses the base Gilhari docker image (softwaretree/gilhari) to easily create a new docker image (gilhari_autoincrement_example) that can run as a RESTful microservice (server) to persist app specific JSON objects.

This example can be used standalone as a RESTful microservice or optionally with the ORMCP Server.

Related:

• ORMCP Documentation: https://github.com/softwaretree/ormcp-docs
• ORMCP/Gilhari Examples: https://github.com/softwaretree/ormcp-docs#examples - Comprehensive list of examples

Note: This example is also included in the Gilhari SDK distribution. If you have the SDK installed, you can use it directly from the examples/gilhari_autoincrement_example directory without cloning.

Example Overview

The example showcases a JSON object model with one type of object: Employee2 (or JSON_Employee2)

Object Model Overview:

• JSON_Employee2: Simple employee object with auto-generated ID
• Attributes: id (auto-generated), name, exempt (boolean), compensation (double), DOB (long/milliseconds)
• Database Table: Employee2 with column empId for the ID

What Makes This Example Different?

This example is similar to gilhari_simple_example, but with a key difference:

Database-Generated IDs:

• The database automatically generates a unique ID (primary key) for each Employee object when inserted
• Clients do not need to specify an id value in POST requests
• Even if a client specifies an id value, it is ignored by Gilhari
• When queried, objects return with their database-assigned IDs

Configuration: See config/gilhari_autoincrement_example.jdx for how to configure autoincrement functionality.

Note: To avoid confusion with other examples, this uses Employee2 or JSON_Employee2 as the container domain model class name.

Employee2 Object Structure

{
  "name": "John Doe",
  "exempt": true,
  "compensation": 75000.00,
  "DOB": 631152000000
}

Note: The id field is not included in POST requests - it's automatically generated by the database. The DOB is represented as milliseconds since epoch (standard for JSON date representation).

After Insertion (with database-assigned ID)

{
  "id": 1,
  "name": "John Doe",
  "exempt": true,
  "compensation": 75000.00,
  "DOB": 631152000000
}

Project Structure

gilhari_autoincrement_example/
├── src/                           # Container domain model classes
│   └── com/softwaretree/...      # JSON_Employee2.java and base classes
├── config/                        # Configuration files
│   ├── gilhari_autoincrement_example.jdx  # ORM specification with autoincrement
│   └── classnames_map_example.js
├── bin/                           # Compiled .class files
├── Dockerfile                     # Docker image definition
├── gilhari_service.config         # Service configuration
├── compile.cmd / .sh              # Compilation scripts
├── build.cmd / .sh                # Docker build scripts
├── run_docker_app.cmd / .sh       # Docker run scripts
└── curlCommands.cmd / .sh         # API testing scripts

Source Code

The src directory contains the declarations of the underlying shell (container) classes (e.g., JSON_Employee2) that are used to define the object-relational mapping (ORM) specification for the corresponding conceptual domain-specific JSON object model classes:

• JSON_Employee2 class: Simple shell (container) class (.java file) corresponding to the domain-specific JSON object model classes of related entities (Container domain model classes)
• JDX_JSONObject: Base class of the container domain model classes for handling persistence of domain-specific JSON objects
• Container domain model classes: Only need to define two constructors, with most processing handled by the JDX_JSONObject superclass

Note: Gilhari does not require any explicit programmatic definitions (e.g., ES6 style JavaScript classes) for domain-specific JSON object model classes. It handles the data of domain-specific JSON objects using instances of the container domain model classes and the ORM specification.

Configurations

A declarative ORM specification for the domain-specific JSON object model classes and their attributes is defined in config/gilhari_autoincrement_example.jdx using the container domain model classes. This file defines the mappings between JSON objects and database tables, including the autoincrement configuration for primary keys.

Key points:

• Update the database URL and JDBC driver in this file according to your setup
• See JDX_DATABASE_JDBC_DRIVER_Specification_Guide (.md or .html) for guides on configuring different databases
• The container domain model classes (like JSON_Employee2) corresponding to the conceptual domain-specific JSON object model classes are defined as subclasses of the JDX_JSONObject class
• Appropriate mappings for the domain-specific JSON object model classes are defined in the ORM specification file using the corresponding container domain model classes
• Autoincrement configuration tells the database to generate unique IDs automatically

For comprehensive details on defining and using container classes and the ORM specification for JSON object models, refer to the "Persisting JSON Objects" section in the JDX User Manual.

Autoincrement Configuration

The key to this example is in the ORM specification file (config/gilhari_autoincrement_example.jdx), where the primary key is configured to use database autoincrement.

For SQLite (as shown in this example):

SQLMAP FOR id COLUMN_NAME empId SQLTYPE 'INTEGER PRIMARY KEY AUTOINCREMENT'
RDBMS_GENERATED id

For MySQL:

SQLMAP FOR id COLUMN_NAME empId SQLTYPE 'INTEGER AUTO_INCREMENT'
RDBMS_GENERATED id

The RDBMS_GENERATED directive tells Gilhari that the database will generate the ID value.

Docker Configuration

The Dockerfile builds a RESTful Gilhari microservice using:

• Base Gilhari image (softwaretree/gilhari)
• Compiled domain model (.class) files
• Configuration files including the ORM specification and a JDBC driver

Service Configuration

The gilhari_service.config file specifies runtime parameters for the RESTful Gilhari microservice:

{
  "gilhari_microservice_name": "gilhari_autoincrement_example",
  "jdx_orm_spec_file": "./config/gilhari_autoincrement_example.jdx",
  "jdbc_driver_path": "/node/node_modules/jdxnode/external_libs/sqlite-jdbc-3.50.3.0.jar",
  "jdx_debug_level": 5,
  "jdx_force_create_schema": "false",
  "jdx_persistent_classes_location": "./bin",
  "classnames_map_file": "config/classnames_map_example.js",
  "gilhari_rest_server_port": 8081
}

Service Configuration Parameters

Parameter	Description	Default
gilhari_microservice_name	Optional name to identify this Gilhari microservice. The name is logged on console during start up	-
jdx_orm_spec_file	Location of the ORM specification file containing mapping for persistent classes	-
jdbc_driver_path	Path to the JDBC driver (.jar) file. SQLite driver included by default	-
jdx_debug_level	Debug output level (0-5). 0 = most verbose, 5 = minimal. Level 3 outputs all SQL statements	5
jdx_force_create_schema	Whether to recreate database schema on each run. true = useful for development, false = create only once	false
jdx_persistent_classes_location	Root location for compiled persistent (Container domain model) classes. Can be a directory (e.g., ./bin) or a JAR file path. Used as a Java CLASSPATH	-
classnames_map_file	Optional JSON file that can map names of container domain model classes to (simpler) object class (type) names (e.g., by omitting a package name) to simplify REST URL	-
gilhari_rest_server_port	Port number for the RESTful service. This port number may be mapped to different port number (e.g., 80) by a docker run command.	8081

Build Files

• compile.cmd / compile.sh: Compiles the container domain model classes
• sources.txt: Lists the names of the container domain model class source (.java) files for compilation
• build.cmd / build.sh: Creates the Gilhari Docker image (gilhari_autoincrement_example) using the local Dockerfile

Note: Compilation targets JDK version 1.8, which is compatible with the current Gilhari version.

Quick Start

For Quick Evaluation (No SDK Required)

If you just want to see this example in action without modifications:

1. Clone this repository (pre-compiled classes included)
2. Install Docker
3. Build and run (skip compilation step)

For Development and Customization

If you want to modify the object model or create your own Gilhari microservices:

1. Gilhari SDK: Download and install from https://softwaretree.com
2. JX_HOME environment variable: Set to the root directory of your Gilhari SDK installation
3. Java Development Kit (JDK 1.8+) for compilation
4. Docker installed on your system

Note: The Gilhari SDK contains necessary libraries (JARs) and base classes required for compiling container domain model classes. While pre-compiled .class files are included in this repository for immediate use, you'll need the SDK to make any modifications to the object model or to create your own Gilhari microservices.

Build and Run

Option 1: Quick Run (Using Pre-compiled Classes)

Skip compilation and go straight to Docker:

# Windows
build.cmd
run_docker_app.cmd

# Linux/Mac
./build.sh
./run_docker_app.sh

Option 2: Compile and Run (For Modifications)

If you've made changes to the source code:

1. Ensure JX_HOME is set to your Gilhari SDK installation directory

2. Compile the classes:

   # Windows
   compile.cmd
   
   # Linux/Mac
   ./compile.sh

3. Build and run the Docker container:

   # Windows
   build.cmd
   run_docker_app.cmd
   
   # Linux/Mac
   ./build.sh
   ./run_docker_app.sh

REST API Usage

Once running, access the Gilhari microservice at:

http://localhost:<port>/gilhari/v1/:className

Example endpoints:

http://localhost:80/gilhari/v1/Employee2

Supported HTTP Methods

Method	Purpose	Example
GET	Retrieve objects	GET /gilhari/v1/Employee2
POST	Create objects (ID auto-generated)	POST /gilhari/v1/Employee2
PUT	Update objects	PUT /gilhari/v1/Employee2
PATCH	Partial update	PATCH /gilhari/v1/Employee2
DELETE	Delete objects	DELETE /gilhari/v1/Employee2

Example: Creating an Employee Without Specifying ID

POST Request:

curl -X POST http://localhost:80/gilhari/v1/Employee2 \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Jane Smith",
    "exempt": false,
    "compensation": 68000.00,
    "DOB": 694224000000
  }'

GET Request:

curl -X GET "http://localhost:80/gilhari/v1/Employee2"  \
  -H "Content-Type: application/json"

Response (with database-generated ID):

{
  "id": 1,
  "name": "Jane Smith",
  "exempt": false,
  "compensation": 68000.00,
  "DOB": 694224000000
}

Testing the API

Pre-built test scripts:

• curlCommands.cmd / .sh: Pre-configured REST API test calls demonstrating autoincrement behavior

Other options:

• Postman: Import the endpoints for interactive testing
• Browser: Access GET endpoints directly
• Any REST Client: Standard HTTP methods work with any REST client
• ORMCP Server (optional): Use ORMCP Server tools for AI-powered interactions

Using with ORMCP Server (Optional)

This Gilhari microservice can be used with the ORMCP Server for AI-powered database interactions:

1. Start this Gilhari microservice (as shown in Quick Start)
2. Configure ORMCP Server to connect to this microservice endpoint
3. Use ORMCP tools to query and manipulate Employee2 objects through natural language

The ORMCP Server will automatically handle the autoincrement ID behavior when creating new objects.

For more information on ORMCP Server:

• ORMCP Documentation: https://github.com/softwaretree/ormcp-docs
• ORMCP/Gilhari Examples: https://github.com/softwaretree/ormcp-docs#examples
• Product Website: https://www.softwaretree.com/products/ormcp/

Development Tools

Docker Container Access

Shell into a running container:

# Find container ID
docker ps

# Access container
docker exec -it <container-id> bash

View Logs

docker logs <container-id>

Stop Container

docker stop <container-id>

Additional Resources

• JDX User Manual: "Persisting JSON Objects" section for detailed ORM specification documentation
• Gilhari SDK Documentation: The SDK available for download at https://softwaretree.com
• ORMCP Documentation: https://github.com/softwaretree/ormcp-docs
• Database Configuration Guide: See JDX_DATABASE_JDBC_DRIVER_Specification_Guide.md
• operationDetails Documentation: See operationDetails_doc.md for GraphQL-like query capabilities

Platform Notes

Script files are provided for both Windows (.cmd) and Linux/Mac (.sh).

Linux/Mac users: Make scripts executable before running:

chmod +x *.sh

Troubleshooting

Common Issues

Problem: Docker image build fails

• Solution: Ensure the base Gilhari image is pulled: docker pull softwaretree/gilhari

Problem: Compilation errors

• Solution: Verify JDK 1.8+ is installed and JX_HOME environment variable is set correctly

Problem: Port 80 already in use

• Solution: Modify run_docker_app script to use a different port (e.g., -p 8080:8081)

Problem: Database connection errors

• Solution: Check config/gilhari_autoincrement_example.jdx for correct database URL and JDBC driver path

Problem: IDs are not being auto-generated

• Solution: Verify the ORM specification has RDBMS_GENERATED id and proper SQLTYPE for autoincrement (e.g., 'INTEGER PRIMARY KEY AUTOINCREMENT' for SQLite)

Support

For issues or questions:

• ORMCP Documentation & Issues: https://github.com/softwaretree/ormcp-docs/issues
• This example: https://github.com/SoftwareTree/gilhari_autoincrement_example/issues
• Gilhari SDK: Contact support at gilhari_support@softwaretree.com

License

This example code is licensed under the MIT License - see the LICENSE file for details.

Important: This license applies ONLY to the example code in this repository. The Gilhari software (including the softwaretree/gilhari Docker image and Gilhari SDK) and the embedded JDX ORM software are proprietary products owned by Software Tree.

The Gilhari Docker image includes an evaluation license for testing purposes. For production use or licensing beyond the evaluation period, please visit https://www.softwaretree.com or contact gilhari_support@softwaretree.com.

---

Ready to try it? Start with the Quick Start section above!