Adds Query Language by FriedJannik · Pull Request #814 · eclipse-basyx/basyx-java-server-sdk

FriedJannik · 2025-08-11T11:34:36Z

Description of Changes

This PR adds a first implementation for the AAS Query Language as defined per specification of the IDTA.

BaSyx Configuration for Testing

See the BaSyxQueryLanguage folder in the examples as a reference
examples/BaSyxQueryLanguage/docker-compose.yml

Additional Information

There are still some operators that are not fully implemented yet:

Querying in Submodel Elements
Operators: $gt, $lt, $le, $ge

Please feel free to report any problems as an issue.

- Adapts README

- Fixes field-to-field comparisons - Enables AASQL for AAS Registry Log MongoDB - [WIP] initiates Search Feature for AasRegistry by Jannis Jung Co-authored-by: Jannis Jung <jannis.jung@iese.fraunhofer.de> Co-authored-by: Aaron Zielstorff <aaron.zi@web.de>

This reverts commit f8e0e5d.

- Removes unused files

- Adapts RestControllers of Registries

Copilot

Pull Request Overview

This PR adds a first implementation for the AAS Query Language as defined per IDTA specification. The implementation provides search capabilities for submodel registries and concept description repositories using Elasticsearch as the search backend.

Key changes include:

Implementation of the AAS Query Language (AASQL) converter for Elasticsearch
Search features for Submodel Registry with indexing and query capabilities
Search features for Concept Description Repository with similar functionality

Reviewed Changes

Copilot reviewed 123 out of 163 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
basyx.common/pom.xml	Adds querycore module to common components
basyx.conceptdescriptionrepository/pom.xml	Adds search feature module for concept descriptions
basyx.submodelregistry/basyx.submodelregistry-feature-search/pom.xml	Maven configuration for submodel registry search feature
basyx.conceptdescriptionrepository/basyx.conceptdescriptionrepository-feature-search/pom.xml	Maven configuration for concept description search feature
Multiple source files	Core implementation of search functionality, API controllers, and configuration

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-08-20T13:47:41Z

+
+    @Override
+    public Set<String> clear() {
+        return Set.of();


The clear() method returns an empty Set instead of actually clearing the storage. This should delegate to the decorated storage's clear() method and also clear the Elasticsearch index.

Suggested change

return Set.of();

Set<String> clearedIds = decorated.clear();

try {

esclient.deleteByQuery(d -> d

.index(indexName)

.query(q -> q.matchAll(m -> m))

);

} catch (IOException e) {

throw new RuntimeException(e);

}

return clearedIds;

Copilot · 2025-08-20T13:47:41Z

+                // Hard Code to only retrieve ids -> Fetching the actual SM Descs from MongoDB
+                query.set$select("id");
+                queryResponse = getQueryResponse(query, limit, cursor);
+                queryResponse.paging_metadata.resulType = "SubmodelDescriptor";


Spelling error: 'resulType' should be 'resultType'.

Suggested change

queryResponse.paging_metadata.resulType = "SubmodelDescriptor";

queryResponse.paging_metadata.resultType = "SubmodelDescriptor";

Copilot · 2025-08-20T13:47:41Z

+				// Hard Code to only retrieve ids -> Fetching the actual CD from MongoDB
+				query.set$select("id");
+				queryResponse = getQueryResponse(query, limit, cursor);
+				queryResponse.paging_metadata.resulType = "ConceptDescription";


Spelling error: 'resulType' should be 'resultType'.

Suggested change

queryResponse.paging_metadata.resulType = "ConceptDescription";

queryResponse.paging_metadata.resultType = "ConceptDescription";

Copilot · 2025-08-20T13:47:42Z

+            error = true;
+        } else {
+            logger.info("BaSyx Backend: " + basyxBackend);
+        }


Potential NullPointerException: basyxBackend could be null. Should use Objects.equals() or add null check before calling equals().

Suggested change

}

if (Objects.equals(basyxBackend, "InMemory")) {

logger.error("BaSyx Backend is set to InMemory. Search feature requires a persistent backend.");

error = true;

} else {

logger.info("BaSyx Backend: " + basyxBackend);

}

Copilot · 2025-08-20T13:47:42Z

+		searchAPI = appContext.getBean(SearchSubmodelRegistryApiHTTPController.class);
+		preloadSmds();
+		Thread.sleep(2000);
+	}


Hard-coded sleep in tests is unreliable and slows down test execution. Consider using proper synchronization mechanisms or polling with timeout instead.

Suggested change

}

@BeforeClass

public static void setUp() throws IOException, DeserializationException, InterruptedException {

appContext = new SpringApplication(DummySearchSubmodelRegistryComponent.class).run(new String[] {});

storage = appContext.getBean(SearchSubmodelRegistryStorage.class);

searchAPI = appContext.getBean(SearchSubmodelRegistryApiHTTPController.class);

preloadSmds();

waitForSearchApiReady();

}

We should definitely consider this.

Copilot · 2025-08-20T13:47:42Z

+
+    private static void waitForData() throws InterruptedException {
+        Thread.sleep(2000);
+    }


Hard-coded sleep in tests is unreliable and slows down test execution. Consider using proper synchronization mechanisms or polling with timeout instead.

Suggested change

}

private static void waitForData() throws InterruptedException {

// Wait up to 5 seconds for at least one ConceptDescription to be available

int maxAttempts = 50;

int attempt = 0;

while (searchBackend.getAllConceptDescriptions(new PaginationInfo(0, "")).getResult().isEmpty() && attempt < maxAttempts) {

Thread.sleep(100);

attempt++;

}

if (searchBackend.getAllConceptDescriptions(new PaginationInfo(0, "")).getResult().isEmpty()) {

throw new IllegalStateException("ConceptDescriptions not available after waiting for data.");

}

}

We should definitely consider this.

aaronzi

Please also add the search example to the GitHub Actions

aaronzi · 2025-08-21T11:53:19Z

Line endings must have changed here. please revert this change so that the actual diff is visible

aaronzi · 2025-08-21T11:53:36Z

Please check line endings here as well

aaronzi · 2025-08-21T11:53:50Z

Please revert change of line endings

aaronzi · 2025-08-21T11:57:07Z

Please revert line endings change

aaronzi · 2025-08-21T11:57:46Z

@@ -0,0 +1,181 @@
+/*******************************************************************************
+ * Copyright (C) 2024 the Eclipse BaSyx Authors


Suggested change

* Copyright (C) 2024 the Eclipse BaSyx Authors

* Copyright (C) 2025 the Eclipse BaSyx Authors

aaronzi · 2025-08-21T11:58:33Z

Please revert line endings change

aaronzi · 2025-08-21T11:59:36Z

Revert changes please

aaronzi · 2025-08-21T11:59:51Z

Please revert line endings change

aaronzi · 2025-08-21T12:00:30Z

Please revert this file

aaronzi · 2025-08-21T12:00:59Z

Please revert this file

FriedJannik and others added 30 commits June 4, 2025 14:54

Adds ElasticSearch and first draft of AASQL to ES QueryDSL Converter

a972761

New Converter

b544039

Converts Hits

ee3f1d7

Updates Readme

6aa494d

Updates Readme

9445a09

Refactors Query Core

2eb0bc5

Refactor

b3f9e85

Adds field-to-field comparison (WIP)

83ef356

Adds missing dependency for ES Client in Component

eed75a8

- Adapts README

Refactors HTTP Controller

bba4d32

- Fixes field-to-field comparisons - Enables AASQL for AAS Registry Log MongoDB - [WIP] initiates Search Feature for AasRegistry by Jannis Jung Co-authored-by: Jannis Jung <jannis.jung@iese.fraunhofer.de> Co-authored-by: Aaron Zielstorff <aaron.zi@web.de>

Makes QueryResponse explicit

f8e0e5d

Revert "Makes QueryResponse explicit"

1b375e3

This reverts commit f8e0e5d.

Makes indizes Configurable

8935bbf

WIP - adds unit tests

2713747

Adds Unit Tests and implements Casting Operators

a0aded0

WIP Adds QL for other modules

d20f9a5

WIP

1fa1f6e

tries to fix indexing of submodels

5975596

WIP Adds QL for other modules

c2de6da

Adds Field Renaming

40bd0e7

Changes Recursion to Iterative Method

d43d397

Cahnges CRLF to LF

d542f23

Adds Querying for nested SME's

4a282e4

Adapts SM Repo QL

7c544f8

Other Search Components Utilize MongoDB now

0614143

Adapts Path Parsing

080aaac

Adapts Path Parsing

2af0568

Adapts QL

7cbf097

Adapts QL

624378f

Intermediate Commit

f595007

FriedJannik added 17 commits August 19, 2025 10:59

IC

376cc62

AAS Registry IT

e6f6878

Merge remote-tracking branch 'basyx/main' into queryLanguage

36449ea

Adds missing parameter

7029952

Fixes docker-compose.yml

5109adf

Reverts changes in application.properties

2c87155

Adds missing .env entries

cd8ee88

- Removes unused files

Adapts output json to new converter format

2f43b9f

Adapts application.properties

f96d7c4

- Adapts RestControllers of Registries

Adapts Autoconfiguration

a038110

Adds missing ConditionalOnExpression

41d1f56

Adapts

33d6e82

Adapts

6ef9ba7

Adapts

e4a7271

Fixes some issues with spring

e937f63

Adds Timeout (TODO)

498b65b

Adds missing line

5aafcab

aaronzi requested a review from Copilot August 20, 2025 13:44

Copilot AI reviewed Aug 20, 2025

View reviewed changes

FriedJannik added 5 commits August 21, 2025 08:42

Removes hard-coded thread.sleep and adds awaitility

a2118f3

Adapts limit

9aba29c

Adapts test

e091a09

Adapts test

32b3b2c

Adds Thread.sleep for the moment

9e2456d

FriedJannik mentioned this pull request Aug 21, 2025

Rework Feature Search Tests (No Thread.sleep) #822

Open

FriedJannik marked this pull request as ready for review August 21, 2025 10:54

aaronzi requested changes Aug 21, 2025

View reviewed changes

Review remarks

25607c6

aaronzi merged commit a542451 into eclipse-basyx:main Aug 21, 2025
43 checks passed

-        return Set.of();
+        Set<String> clearedIds = decorated.clear();
+        try {
+            esclient.deleteByQuery(d -> d
+                .index(indexName)
+                .query(q -> q.matchAll(m -> m))
+            );
+        } catch (IOException e) {
+            throw new RuntimeException(e);
+        }
+        return clearedIds;

	queryResponse.paging_metadata.resulType = "SubmodelDescriptor";
	queryResponse.paging_metadata.resultType = "SubmodelDescriptor";

-	}
+	@BeforeClass
+	public static void setUp() throws IOException, DeserializationException, InterruptedException {
+		appContext = new SpringApplication(DummySearchSubmodelRegistryComponent.class).run(new String[] {});
+		storage = appContext.getBean(SearchSubmodelRegistryStorage.class);
+		searchAPI = appContext.getBean(SearchSubmodelRegistryApiHTTPController.class);
+		preloadSmds();
+		waitForSearchApiReady();
+	}

-    }
+    private static void waitForData() throws InterruptedException {
+        // Wait up to 5 seconds for at least one ConceptDescription to be available
+        int maxAttempts = 50;
+        int attempt = 0;
+        while (searchBackend.getAllConceptDescriptions(new PaginationInfo(0, "")).getResult().isEmpty() && attempt < maxAttempts) {
+            Thread.sleep(100);
+            attempt++;
+        }
+        if (searchBackend.getAllConceptDescriptions(new PaginationInfo(0, "")).getResult().isEmpty()) {
+            throw new IllegalStateException("ConceptDescriptions not available after waiting for data.");
+        }
+    }

		@@ -0,0 +1,181 @@
		/*******************************************************************************
		* Copyright (C) 2024 the Eclipse BaSyx Authors

	* Copyright (C) 2024 the Eclipse BaSyx Authors
	* Copyright (C) 2025 the Eclipse BaSyx Authors

Conversation

FriedJannik commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of Changes

BaSyx Configuration for Testing

Additional Information

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

aaronzi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

FriedJannik commented Aug 11, 2025 •

edited

Loading