From c899f1cb85fa60663431ae80eb0d4b65edc5e78e Mon Sep 17 00:00:00 2001 From: Viktor Lofgren Date: Mon, 9 Oct 2023 14:56:59 +0200 Subject: [PATCH] (docs) Update documentation to reflect new query service --- code/readme.md | 2 +- code/services-core/query-service/readme.md | 15 +++++++++++++++ doc/diagram/conceptual-overview.svg | 2 +- 3 files changed, 17 insertions(+), 2 deletions(-) create mode 100644 code/services-core/query-service/readme.md diff --git a/code/readme.md b/code/readme.md index 8d20f90b..f67f0aee 100644 --- a/code/readme.md +++ b/code/readme.md @@ -14,7 +14,7 @@ A map of the most important components and how they relate can be found below. ### Services * [core services](services-core/) "macroservices", stateful, memory hungry doing heavy lifting. -* * [control-service](services-core/control-service) +* * [control](services-core/control-service) * * [query](services-core/query-service) * * [index](services-core/index-service) * * [assistant](services-core/assistant-service) diff --git a/code/services-core/query-service/readme.md b/code/services-core/query-service/readme.md new file mode 100644 index 00000000..aa335ce4 --- /dev/null +++ b/code/services-core/query-service/readme.md @@ -0,0 +1,15 @@ +The query service parses search queries and delegates work to the index service. + +The [index-service](../index-service) speaks a lower level query specification language +that is difficult to build an application out of. The query service exists as an interpreter +to that format. + +## Main Classes + +* [QueryService](src/main/java/nu/marginalia/query/QueryService.java) + +## See Also + +* [api/query-api](../../api/query-api) +* [features-search/query-parser](../../features-search/query-parser) +* [features-index/index-query](../../features-index/index-query) \ No newline at end of file diff --git a/doc/diagram/conceptual-overview.svg b/doc/diagram/conceptual-overview.svg index 2d0b7ad5..134cf666 100644 --- a/doc/diagram/conceptual-overview.svg +++ b/doc/diagram/conceptual-overview.svg @@ -1,4 +1,4 @@ -
Search Service

parse query,
rank results
Search Service...
Assistant Service

spelling correction,
keyword suggestions
Assistant Service...
Index Service

find documents that
contain specific keywords
Index Service...
Fwd Index

doc->word
Fwd Index...
Prio Index

word->doc
Prio Index...
Full Index

word->doc
Full Index...
SQL Database

domains
SQL Database...
convert
convert
convert
convert
convert
convert
Crawler Process

download website
html code
Crawler Process...
Converter Process

extract keywords
and metadata
Converter Process...
Loader Process

load data into the system
Loader Process...
Index
Journal
Index...
Control Service

orchestrate processes
ops GUI
Control Service...
Message Queue
Message Queue
SQLite database

urls, titles,
descriptions
SQLite database...
Text is not SVG - cannot display
\ No newline at end of file +
Assistant Service

spelling correction,
keyword suggestions
Assistant Service...
Index Service

find documents that
contain specific keywords,
rank results
Index Service...
Fwd Index

doc->word
Fwd Index...
Prio Index

word->doc
Prio Index...
Full Index

word->doc
Full Index...
SQL Database

domains
SQL Database...
convert
convert
convert
convert
convert
convert
Crawler Process

download website
html code
Crawler Process...
Converter Process

extract keywords
and metadata
Converter Process...
Loader Process

load data into the system
Loader Process...
Index
Journal
Index...
Control Service

orchestrate processes
ops GUI
Control Service...
Message Queue
Message Queue
SQLite database

urls, titles,
descriptions
SQLite database...
Query Service

parse query and
delegate work to
index service
Query Service...
search-service

Marginalia Search
application
search-service...
api-service

Public API
api-service...
Application Services
Applicatio...
Core Services
Core Services
Text is not SVG - cannot display
\ No newline at end of file