Demos

This framework comes with 3 examples, each example provides two projects for Java and Kotlin, a total of 6 projects.

Java	Kotlin	Description
example/java/jimmer-core	example/kotlin/jimmer-core-kt	Show jimmer-core related functions
example/java/jimmer-sql	example/kotlin/jimmer-sql-kt	Show jimmer-sql related functions
example/java/jimmer-sql-graphql	example/kotlin/jimmer-core-kt	Demonstrate support for SpringGraphQL

Of these six projects, two are simple programs, and the other four are spring-boot applications.

Therefore, you can open it with intellij, wait for the gradle dependencies to be downloaded, and run the main function directly.

Mode for database related demos

jimmer-sql, jimmer-sql-kt, jimmer-sql-graphql and jimmer-sql-graphql-ktboth involve database operations and have two modes: cached and non-cached.

Non-cached mode

These four projects are spring boot projects, and the application.yml file corresponding to the default profile can run the example in uncached mode.

note

Non-cached mode uses embedded H2 in-memory database, which is automatically initialized on every run.

It can be run directly without any environment preparation, and the modifications to the database will be lost when the program exits.

Cached mode

These four projects are spring boot projects, and the application-cache.yml file can run the example in cached mode.

note

The cached mode uses the MySQL database in docker, the database is initialized by the install script.

Modifications to the database are permanent. To reset the database, the MySQL database must be reinstalled.

Environment installation

1. Make sure docker is installed on local machine
2. Open the command line and go to <project-cloned-home>/example/env-with-cache
3. Execute install.sh

Use any of the following methods to run the demo in cached mode

• Option 1: Add --spring.profiles.active=cache into program arguemnts
• Option 2: Add -Dspring.profiles.active=cache into VM options

jimmer-core and jimmer-core-kt

These two projects are the simplest examples and do not involve database operations. Just run them directly and observe the output.

jimmer-sql and jimmer-sql-kt

These two projects are Spring REST programs. After starting the program, use a browser to access http://localhost:8080/ui or http://localhost:8080/swagger-ui/index.html to enter the online documentation for direct experience .

This example supports multi-tenancy and can set the global tenant name for the current operator

• Tenant setting is optional for query operations
• Tenant settings are required for modification operations
• Tenant can be set to a or b

To set the global tenant name for the current operator, you can click the Authorize button in the online documentation

The following operations are supported

GET /books

Find books

The command has multiple optional parameters, as follows

Parameter	Description	Default value
fetch	The return type of query is Book. If this parameter is true, it means Book.store, Book.store.avgPrice and Book.authors are also fetched.	false
name	The filter of Book.name
storeName	The fitler of Book.store.name
authorName	The filter of Book.authors.firstName or Book.authors.lastName
pageIndex	Page index	0
pageSize	Number of records per page	5

PUT /book

Save book and its associated objects

This command requires the request body to be a dynamic entity object of type Book. any format, but

• For the current Book object, either id or name and edition must be specified.
• If the current object's many-to-one associated property Book.store is specified, for the associated object, id or name must be specified.
• If the current object's many-to-many association property Book.authors is specified, for each association object, either id or firstName and lastName must be specified.
• If the final operation is an insert instead of an update, the price property of the current Book object must be specified.
• The global tenant must be set.

GET /stores

Find all book stores

The command has multiple optional parameters, as follows

Parameter	Description	Default value
fetch	The return type of query is BookStore. If this parameter is true, it means BookStore.avgPrice, BookStore.books and BookStore.books.authors are also fetched	false

GET /authors

Find authors

The command has multiple optional parameters, as follows

Parameter	Description	Default value
fetch	The return type of query is Autor. If this parameter is true, it means Author.books, Author.books.store and Author.books.store.avgPrice are also fetched	false
firstName	Fuzzy conditions	""
lastName	Fuzzy conditions	""
gender	Author's gender	null

GET /trees

Query all root (parent is null) nodes and recursively fetch all child nodes, no matter how deep

The command has multiple optional parameters, as follows

Parameter	Description	Default value
rootName	The filter of TreeNode.name
noRecursiveNames	Node names that do not require recursion, if there are multiple, separate them with commas

PUT /tree

Save (create or replace) a tree with any depth and breadth

The command parameters are as follows

Parameter	Description	Mandatory	Default
rootName	The name of the root node of the tree to save	Yes
depth	The depth of the tree to save, excluding the root node itself	No	2
breadth	The number of children of each node except leaf nodes	No	2

For example

PUT /tree rootName=`MyNode`&depth=`2`&breadth=`3`

means to save (create or replace) such a tree

{
    "name" : "MyNode",
    "parent" : null,
    "childNodes" : [
        {
            "name" : "MyNode-1",
            "childNodes" : [
                {
                    "name" : "MyNode-1-1",
                    "childNodes" : []
                }, 
                {
                    "name" : "MyNode-1-2",
                    "childNodes" : []
                }
            ]
        }, 
        {
            "name" : "MyNode-2",
            "childNodes" : [
                {
                    "name" : "MyNode-2-1",
                    "childNodes" : []
                }, 
                {
                    "name" : "MyNode-2-2",
                    "childNodes" : []
                }
            ]
        }
    ]
}

DELETE /tree/{id}

Delete tree node by root node id, including all its subordinate nodes

jimmer-sql-graphql and jimmer-sql-graphql-kt

These two projects are GraphQL services. Once launched, you can use browser to visit http://localhost:8080/graphiql.

This page provides the online documentation of the GraphQL API. according to its instructions, you can enter the query or mutation request and execute it.

This example supports multi-tenancy and can set the global tenant name for the current operator

• Tenant setting is optional for query operations
• Tenant settings are required for modification operations
• Tenant can be set to a or b

To set the global tenant name for the current operator, you can click the Authorize button in the online documentation