summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/src/SQLStore/QueryEngine/README.md
blob: a6d9dc21102a6fefe42ce8da2ee139c63fb7150f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# QueryEngine

The `QueryEngine` handles the transformation of the `ask` query language into a `SQL` construct and is also
responsible to return query results from the `SQL` back-end with the help of the following components:

- The `QuerySegmentListBuilder` transforms `ask` descriptions into individual `QuerySegment`'s (aka `QuerySegmentList`)
- The `DescriptionInterpreter` interface describes classes that are responsible to interpret a specific
  `Description` object and turn it into an abstract `SQL` construct (a `QuerySegment`)
- The `QuerySegmentListProcessor` flattens and transforms a list of `QuerySegment`'s into a non-recursive
  tree of `SQL` statements (including resolving of property/category hierarchies)
- The `ConceptQueryResolver` encapsulates query processing of a concept description in connection
  with the `ConceptCache` class

## Overview

![image](https://cloud.githubusercontent.com/assets/1245473/10050078/ca42ff12-621a-11e5-84c3-5fd04d945c6c.png)

### Examples
```php
/**
 * Equivalent to [[Category:Foo]]
 */
$classDescription = new ClassDescription(
	new DIWikiPage( 'Foo', NS_CATEGORY )
);

/**
 * Equivalent to [[:+]]
 */
$namespaceDescription = new NamespaceDescription(
	NS_MAIN
);

/**
 * Equivalent to [[Foo::+]]
 */
$someProperty = new SomeProperty(
	new DIProperty( 'Foo' ),
	new ThingDescription()
);

/**
 * Equivalent to [[:+]][[Category:Foo]][[Foo::+]]
 */
$description = new Conjunction( [
	$namespaceDescription,
	$classDescription,
	$someProperty
] );
```
```php
$query = new Query( $description );
$query->setLimit( 10 );

$sqlStorefactory = new SQLStoreFactory(
  new SQLStore()
);

$queryEngine = $sqlStorefactory->newMasterQueryEngine();
$queryResult = $queryEngine->getQueryResult( $query );
```