Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jeroendedauw/mediawiki-extensions-wikibasequeryengine
Github mirror of MediaWiki extension WikibaseQueryEngine - our actual code is hosted with Gerrit (please see https://www.mediawiki.org/wiki/Developer_access for contributing
https://github.com/jeroendedauw/mediawiki-extensions-wikibasequeryengine
Last synced: 8 days ago
JSON representation
Github mirror of MediaWiki extension WikibaseQueryEngine - our actual code is hosted with Gerrit (please see https://www.mediawiki.org/wiki/Developer_access for contributing
- Host: GitHub
- URL: https://github.com/jeroendedauw/mediawiki-extensions-wikibasequeryengine
- Owner: JeroenDeDauw
- License: other
- Created: 2013-10-27T15:24:47.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2013-10-26T15:14:59.000Z (about 11 years ago)
- Last Synced: 2024-10-16T14:41:14.834Z (about 1 month ago)
- Language: PHP
- Size: 684 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# Wikibase QueryEngine
[](http://travis-ci.org/wikimedia/mediawiki-extensions-WikibaseQueryEngine)
[](https://coveralls.io/r/wikimedia/mediawiki-extensions-WikibaseQueryEngine?branch=master)
[](https://www.versioneye.com/package/php--wikibase--query-engine)
On [Packagist](https://packagist.org/packages/wikibase/query-engine):
[](https://packagist.org/packages/wikibase/query-engine)
[](https://packagist.org/packages/wikibase/query-engine)
Component containing query answering code for
[Ask](https://www.mediawiki.org/wiki/Extension:Ask)
queries against a collection of
[Wikibase](https://www.mediawiki.org/wiki/Wikibase)
entities.
## Requirements
* PHP 5.3 or later
* [DataValues](https://www.mediawiki.org/wiki/Extension:DataValues) 0.1 or later
* [Ask](https://github.com/wikimedia/mediawiki-extensions-Ask/blob/master/README.md) 0.1 or later
* [Wikibase DataModel](https://www.mediawiki.org/wiki/Extension:Wikibase_DataModel) 0.4 or later
* [Wikibase Database](https://www.mediawiki.org/wiki/Extension:WikibaseDatabase) 0.1 or later
## Installation
You can use [Composer](http://getcomposer.org/) to download and install
this package as well as its dependencies. Alternatively you can simply clone
the git repository and take care of loading yourself.
### Composer
To add this package as a local, per-project dependency to your project, simply add a
dependency on `wikibase/query-engine` to your project's `composer.json` file.
Here is a minimal example of a `composer.json` file that just defines a dependency on
Wikibase QueryEngine 1.0:
{
"require": {
"wikibase/query-engine": "1.0.*"
}
}
### Manual
Get the Wikibase QueryEngine code, either via git, or some other means. Also get all dependencies.
You can find a list of the dependencies in the "require" section of the composer.json file.
Load all dependencies and the load the Wikibase QueryEngine library by including its entry point:
WikibaseQueryEngine.php.
## Usage
The public interfaces in this component are everything directly in the Wikibase\QueryEngine.
Other classes and interfaces are typically package private, and should not be used or known
about outside of the package. Each store implementation has its own list of additional public
classes.
### SQLStore
Public classes of the SQLStore:
Needed for construction:
* SQLStore\Store
* SQLStore\StoreConfig
* SQLStore\DataValueHandlers
Needed for extension:
* SQLStore\DataValueTable
* SQLStore\DataValueHandler
Constructing an SQLStore:
```php
use Wikibase\QueryEngine\SQLStore\Store;
use Wikibase\QueryEngine\SQLStore\StoreConfig;
use Wikibase\QueryEngine\SQLStore\DataValueHandlers;
$dvHandlers = new DataValueHandlers();
$config = new StoreConfig(
'My awesome query store',
'nyan_',
$dvHandlers->getHandlers()
);
$store = new Store( $config, $queryInterface, $tableBuilder );
```
Where
* $queryInterface is a Wikibase\Database\QueryInterface\QueryInterface
* $tableBuilder is a Wikibase\Database\Schema\TableBuilder
## SQLStore internal structure
### Table: entities
* id, string: serialization of the entities id
* type, string: type of the entity
### Table: valueless_snaks
* subject_id, string
* property_id, string
* snak_type, int: type of the snak, ie "no value"
* snak_role, int: role of the snak, ie "qualifier" or "main snak"
### Data value tables
There is a data value table per type of data value the store is configured to support.
Each such table has the following fields:
* subject_id, string
* property_id, string
All data value tables have a set of additional fields that are specific to the type of
data value they store. For the types of data value natively supported by the store,
you can find the table definitions (without the common fields) in the
Wikibase\QueryEngine\SQLStore\DataValueHandlers class.
## Tests
This library comes with a set up PHPUnit tests that cover all non-trivial code. You can run these
tests using the PHPUnit configuration file found in the root directory. The tests can also be run
via TravisCI, as a TravisCI configuration file is also provided in the root directory.
## Authors
Wikibase QueryEngine has been written by [Jeroen De Dauw](https://www.mediawiki.org/wiki/User:Jeroen_De_Dauw)
as [Wikimedia Germany](https://wikimedia.de) employee for the [Wikidata project](https://wikidata.org/).
## Links
* [Wikibase QueryEngine on Packagist](https://packagist.org/packages/wikibase/query-engine)
* [Wikibase QueryEngine on Ohloh](https://www.ohloh.net/p/wikibasequeryengine/)
* [Wikibase QueryEngine on MediaWiki.org](https://www.mediawiki.org/wiki/Extension:Wikibase_QueryEngine)
* [TravisCI build status](https://travis-ci.org/wikimedia/mediawiki-extensions-WikibaseQueryEngine)
* [Latest version of the readme file](https://github.com/wikimedia/mediawiki-extensions-WikibaseQueryEngine/blob/master/README.md)
## Related projects
* [Ask JavaScript implementation](https://github.com/JeroenDeDauw/AskJS)
* [Wikibase](https://www.mediawiki.org/wiki/Wikibase)
* [Semantic MediaWiki](https://semantic-mediawiki.org/)