Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "VIATRA/Query"

 
(88 intermediate revisions by 14 users not shown)
Line 1: Line 1:
= EMF-IncQuery Wiki Documentation =
+
{{VIATRA}}
 +
{{caution|Old information|This page is not updated anymore; for more up-to-date details look at the language specification at https://www.eclipse.org/viatra/documentation/ instead.}}
 +
= VIATRA Incremental Query Wiki Documentation =
  
These are the (work-in-progress) wiki pages for the EMF-IncQuery project. At the moment, much of the EMF-IncQuery documentation resides on IncQuery.net, this will change as the development of this wiki progresses.
+
For the query language, we reuse the concepts of graph patterns (which is a key concept in many graph transformation tools) as a concise and easy way to specify complex structural model queries. High runtime performance is achieved by adapting incremental graph pattern matching techniques based on the Rete algorithm.
  
== Quick pointers ==
+
We believe the average programmer using EMF models will like VIATRA Query for the following reasons:
  
*[http://eclipse.org/incquery Eclipse.org project website]
+
* declarative queries can be evaluated over EMF without manually traversing the models,
*[http://incquery.net IncQuery.net portal]
+
* complex interrelated constellations of EMF objects can be easily formulated as a graph pattern,
*[http://incquery.net/incquery/getting_started Getting Started]
+
** the language is expressive and provides powerful features such as negation or counting,
*[http://incquery.net/incquery/documentation User Documentation]
+
** graph patterns are composable and reusable,
*[http://incquery.net/incquery/devguide Developer Documentation]
+
** queries can be evaluated with great freedom, i.e. input and output parameters can be selected at run-time,
*[http://incquery.net/incquery/examples Examples]
+
** some frequently encountered shortcomings of EMF’s interfaces are addressed:
 +
** easy and efficient enumeration of all instances of a class regardless of location,
 +
** simple backwards navigation along all kinds of references (even without eOpposite)
 +
** finding objects based on attribute value,
 +
* the incremental query evaluation mechanism offers a significant performance boost when frequently querying complex structural patterns with a moderate amount of modifications in-between (e.g. during continuous validation),
 +
* from the declarative representation of queries, pattern matcher code is generated which can be distributed as Eclipse plug-ins with very few dependencies.
  
== EMF-IncQuery User Documentation ==
 
* [[EMFIncQuery/UserDocumentation|User's Documentation]]
 
** [[EMFIncQuery/UserDocumentation/RETE_Visualizer|RETE Visualizer]]
 
** [[EMFIncQuery/UserDocumentation/HeadlessExecution|Headless (standalone) execution of EMF-IncQuery queries and unit tests]]
 
** [[EMFIncQuery/UserDocumentation/API|API documentation]]
 
** [[EMFIncQuery/UserDocumentation/API/Advanced|Advanced API features]]
 
** [[EMFIncQuery/UserDocumentation/AdvancedPatterns|Advanced pattern language constructs]]
 
  
 
+
== VIATRA Query User Documentation ==
== Contributors Guide ==
+
* Developing Incremental Model Queries using the VIATRA Query Tooling
 
+
** [https://www.eclipse.org/viatra/documentation/tutorial.html Getting started with Query Development]
* [[EMFIncQuery/DeveloperDocumentation|Developer's Documentation]]
+
** [[VIATRA/Query/UserDocumentation/QueryLanguage|A Short Introduction to the Query Language]]
** [[EMFIncQuery/DeveloperDocumentation/DevEnvironment|Setting up the Development Environment]]
+
** Advanced topics
** [[EMFIncQuery/DeveloperDocumentation/Model_connectors|Model Connectors]]
+
*** [[VIATRA/Query/UserDocumentation/AdvancedPatterns|Advanced pattern language constructs (incl. recursion)]]
** [[EMFIncQuery/DeveloperDocumentation/IncQuery_Viewers|IncQuery Viewers]]
+
*** [[VIATRA/Query/UserDocumentation/SDK/QueryHotspotTesting|Finding query evaluation hotspots]] (since 1.0.0)
** [[EMFIncQuery/DeveloperDocumentation/EventDrivenVM|Event-driven Virtual Machine]]
+
*** [[VIATRA/Query/UserDocumentation/QueryTestFramework|Query Test Framework]]
 
+
*** [[VIATRA/Query/UserDocumentation/DebuggerTooling|VIATRA Query Debugger Tooling]] (since 0.8.0)
== Releases ==
+
*** [[VIATRA/Query/UserDocumentation/RETE_Visualizer|RETE Visualizer]]
* Version 0.7.0
+
*** [[VIATRA/Query/UserDocumentation/LocalSearch_DebuggerTooling|Local Search Debugger Tooling]]
** [[EMFIncQuery/Releases/MigrateTo0.7|Migration guide]]
+
* Using the VIATRA Query Runtime library
 
+
** [[VIATRA/Query/UserDocumentation/API|API documentation]]
[[Category:EmfIncQuery]]
+
** [[VIATRA/Query/UserDocumentation/API/LocalSearch|Local Search Support]]
 +
** [[VIATRA/Query/UserDocumentation/API/BaseIndexer|Base Indexer]]
 +
** [[VIATRA/Query/UserDocumentation/API/Advanced|Advanced API features]]
 +
** [[VIATRA/Query/UserDocumentation/API/RunOnce|Run once querying API documentation]]
 +
** [[VIATRA/Query/UserDocumentation/HeadlessExecution|Headless (standalone) execution of VIATRA queries and unit tests]]
 +
* Query language extensibility
 +
** [[VIATRA/Query/UserDocumentation/PureWhitelist|Pure whitelist]] (since 1.0.0) for custom code in <code>check()</code> or <code>eval()</code>
 +
** [[VIATRA/Query/UserDocumentation/CustomAggregators|Custom aggregation operators]] (since 1.4.0)
 +
* [[VIATRA/Query/UserDocumentation/Examples|Examples]]
 +
* [[VIATRA/UserDocumentation/Build|VIATRA Query in CI Environments (Maven artifacts)]] (since 0.8.0)
 +
* [[VIATRA/Query/FAQ|Frequently Asked Questions]]

Latest revision as of 09:38, 30 November 2017

Stop.png
Old information
This page is not updated anymore; for more up-to-date details look at the language specification at https://www.eclipse.org/viatra/documentation/ instead.

VIATRA Incremental Query Wiki Documentation

For the query language, we reuse the concepts of graph patterns (which is a key concept in many graph transformation tools) as a concise and easy way to specify complex structural model queries. High runtime performance is achieved by adapting incremental graph pattern matching techniques based on the Rete algorithm.

We believe the average programmer using EMF models will like VIATRA Query for the following reasons:

  • declarative queries can be evaluated over EMF without manually traversing the models,
  • complex interrelated constellations of EMF objects can be easily formulated as a graph pattern,
    • the language is expressive and provides powerful features such as negation or counting,
    • graph patterns are composable and reusable,
    • queries can be evaluated with great freedom, i.e. input and output parameters can be selected at run-time,
    • some frequently encountered shortcomings of EMF’s interfaces are addressed:
    • easy and efficient enumeration of all instances of a class regardless of location,
    • simple backwards navigation along all kinds of references (even without eOpposite)
    • finding objects based on attribute value,
  • the incremental query evaluation mechanism offers a significant performance boost when frequently querying complex structural patterns with a moderate amount of modifications in-between (e.g. during continuous validation),
  • from the declarative representation of queries, pattern matcher code is generated which can be distributed as Eclipse plug-ins with very few dependencies.


VIATRA Query User Documentation

Back to the top