Wikidata query service/User Manual/uk

Wikidata Query Service (WDQS) - це пакет програм та публічна служба, що призначена для надання SPARQL-точок доступу, яка дозволяє вам запитувати збір даних з Вікіданих.

Зверніть увагу, що служба наразі працює в режимі бета-версії, що означає, що елементи набору даних або наданої послуги можуть змінюватися без попереднього попередження.

Цю сторінку або інші відповідні сторінки документації буде відповідно оновлено; рекомендується переглядати їх, якщо ви використовуєте службу.

Ви можете побачити приклади запитів SPARQL на сторінці прикладів SPARQL.

Набір даних
Служба Wikidata Query Service працює на наборі даних з Wikidata.org, представленої в RDF, як це описано в документації RDF dump format.

Набір даних служби не точно збігається з набором даних, згенерованим дампом RDF, переважно з міркувань продуктивності; документація описує невеликий набір відмінностей.

Ви можете завантажити щотижневий дамп тих самих даних із: https://dumps.wikimedia.org/wikidatawiki/entities/

Основи - поняття SPO (підмет, присудок, додаток), також відоме як семантична трійка
spo або "підмет (subject), присудок (predicate), додаток (object)" відомий як трійка, або твердження (statement), яке зазвичай згадується щодо даних у Вікіданих.

Твердження "Небо має колір синій", складається з підмета ("небо"), присудка ("має колір") та додатка ("синій").

spo також використовується як форма основного макета синтаксису для запиту структур даних RDF або будь-якої бази даних графів або сховища трійок, наприклад Wikidata Query Service (WDQS), яка забезпечується Blazegraph, високопродуктивною базою даних графів.

Розширене використання трійок (spo), навіть можна використовувати трійки як додатки або підмети інших трійок!

Основи - поняття префіксів
WDQS розуміє багато коротких абревіатур, відомих як префікси.

Деякі з них є внутрішніми у Вікіданих

і багато інших зазвичай використовують зовнішні префікси, наприклад

- це префікс для твердження, або трійки, або навіть можна вважати це підметом у трійці.

У наступному запиті ми запитуємо елементи, в яких є твердження "P279 = Q7725634" або, детальніше, вибираємо підмети, що мають присудком "є підкласом класу" ("subclass of") з додатком "літературний твір" ("literary work").

Розширення
Служба підтримує такі розширення стандартних можливостей SPARQL:

Служба Label
Ви можете отримати назву (label), псевдонім або опис сутностей, які ви запитуєте, альтернативною мовою, використовуючи спеціалізовану службу з URI . Ця служба дуже корисна, якщо ви хочете отримати назви, оскільки це зменшує складність запитів SPARQL, які вам, в іншому випадку, потрібні для досягнення такого самого ефекту.

Служба може бути використана в одному з двох режимів: ручному та автоматичному.

В автоматичному режимі потрібно лише вказати шаблон служби, наприклад:

і WDQS автоматично згенерує назви так:


 * If an unbound variable in  is named , then WDQS produces the label  for the entity in variable.
 * If an unbound variable in  is named , then WDQS produces the alias  for the entity in variable.
 * If an unbound variable in  is named , then WDQS produces the description  for the entity in variable.

У кожному разі, змінна в  повинна бути зв'язана, в іншому разі служба не працює.

You specify your preferred language(s) for the label with one or more of  triples. Each string can contain one or more language codes, separated by commas. WDQS considers languages in the order in which you specify them. If no label is available in any of the specified languages, the Q-id of the entity (without any prefix) is its label.

The Wikidata Query Service website auto-magically replaces  with the language code of current user's interface. For example, if the user's UI is in French, the SPARQL's code  will be converted to   before being sent to the query service.

Приклад, що показує список президентів США та їхніх дружин:

У цьому прикладі WDQS автоматично створює назви  і   для властивостей.

У ручному режимі ви чітко пов'язуєте змінні назв у межах виклику служби, але WDQS все одно забезпечує розділення мов та резервування. Приклад:

This will consider labels and descriptions in French, German and English, and if none are available, will use the Q-id as the label.

Геопросторовий пошук
Служба дозволяє шукати елементи з координатами, розташованими в колі певного радіуса або в межах певної обмежувальної коробки.

Пошук навколо точки
Приклад:

Перший рядок виклику служби  повинен мати формат     , де результат пошуку буде зв'язувати   з елементами в зазначеному місці та   з їхніми координатами. Підтримувані параметри:

Пошук у коробці
Приклад пошуку в коробці

або:

Координати можна вказати безпосередньо:

Перший рядок виклику служби  повинен мати формат     , де і результат пошуку буде зв'язувати   до елементів у вказаному розташуванні та   до їхніх координат. Підтримувані параметри:

і  слід використовувати разом, а також   і , і не можна змішувати. Якщо використовуються присудки  і , тоді точки вважаються координатами діагоналі коробки, а кути виводяться відповідно.

Функція Distance
Функція  повертає відстань між двома точками на Землі, у кілометрах. Приклад використання:

Coordinate parts functions
Functions,   &   return parts of a coordinate - globe URI, latitude and longitude accordingly.

Decode URL functions
Function  decodes (i.e. reverses percent-encoding) given URI string. This may be necessary when converting Wikipedia titles (which are encoded) into actual strings. This function is an opposite of SPARQL encode_for_uri function.

Автоматичні префікси
Most prefixes that are used in common queries are supported by the engine without the need to explicitly specify them.

Розширені дати
Сервіс підтримує значення дат типу  в діапазоні приблизно 290B років у минулому і в майбутньому з роздільною здатністю в одну секунду. WDQS зберігає дати як 64-бітну кількість секунд з моменту епохи Unix.

Розширення Blazegraph
Blazegraph platform on top of which WDQS is implemented has its own set of SPARQL extension. Among them several graph traversal algorithms which are documented on Blazegraph Wiki, including BFS, shortest path, CC and PageRank implementations.

Please also refer to the Blazegraph documentation on query hints for information about how to control query execution and various aspects of the engine.

Federation
We allow SPARQL Federated Queries to call out to a selected number of external databases. Supported endpoints are: Example federated query:

Зверніть увагу, що перераховані вище бази даних використовують онтології, які можуть сильно відрізнятись від Вікіданих. Будь ласка, зверніться до наведеної вище документації власника, щоб дізнатись про онтології та доступ до даних у цих базах даних.

Mediawiki API
Будь ласка, дивіться повний опис Mediawiki API Service documentation page.

Mediawiki API Service allows to call out to Mediawiki API from SPARQL, and receive the results from inside the SPARQL query. Example (finding category members):

Wikimedia service
Wikimedia runs the public service instance of WDQS, which is available for use at http://query.wikidata.org/.

The runtime of the query on the public endpoint is limited to 60 seconds. That is true both for the GUI and the public SPARQL endpoint. If you need to run longer queries, please contact the Discovery team.

GUI
The GUI at the home page of http://query.wikidata.org/ allows you to edit and submit SPARQL queries to the query engine. The results are displayed as an HTML table. Note that every query has a unique URL which can be bookmarked for later use. Going to this URL will put the query in the edit window, but will not run it - you still have to click "Execute" for that.

One can also generate a short URL for the query via a URL shortening service by clicking the "Generate short URL" link on the right - this will produce the shortened URL for the current query.

The "Add prefixes" button generates the header containing standard prefixes for SPARQL queries. The full list of prefixes that can be useful is listed in the RDF format documentation. Note that most common prefixes work automatically, since WDQS supports them out of the box.

The GUI also features a simple entity explorer which can be activated by clicking on the "🔍" symbol next to the entity result. Clicking on the entity Q-id itself will take you to the entity page on wikidata.org.

Default views

 * Main article: wikidata:Special:MyLanguage/Wikidata:SPARQL query service/Wikidata Query Help/Result Views

If you run the query in the WDQS GUI, you can choose which view to present by specifying a comment:  at the beginning of the query.

SPARQL endpoint
SPARQL queries can be submitted directly to the SPARQL endpoint with a GET or POST request to. The result is returned as XML by default, or as JSON if either the query parameter  or the header   are provided. POST requests also accept the query in the body of the request, instead of URL, allowing to run larger queries without hitting URL length limit. (Note that the POST body must still be, not just  , and the SPARQL query must still be URL-escaped.)

JSON format is standard SPARQL 1.1 Query Results JSON Format.

It is recommended to use GET for smaller queries and POST for larger queries, as POST queries are not cached.

Supported formats
The following output formats are currently supported by the SPARQL endpoint:

Query timeout
There is a hard query deadline configured which is set to 60 seconds.

Every query will timeout when it takes more time to execute than this configured deadline. You may want to optimize the query or report a problematic query here.

Also note that currently access to the service is limited to 5 parallel queries per IP. These limits are subject to change depending on resources and usage patterns.

Linked Data Fragments endpoint
We also support querying the database using Triple Pattern Fragments interface. This allows to cheaply and efficiently browse triple data where one or two components of the triple is known and you need to retrieve all triples that match this template. See more information at the Linked Data Fragments site.

The interface can be accessed by the URL:. Example requests:


 * https://query.wikidata.org/bigdata/ldf?subject=http%3A%2F%2Fwww.wikidata.org%2Fentity%2FQ146 - all triples with subject


 * https://query.wikidata.org/bigdata/ldf?subject=&predicate=http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23label&object=%22London%22%40en - all triples that have English label "London"

Note that only full URLs are currently supported for the,   and   parameters.

By default, HTML interface is displayed, however several data formats are available, defined by  HTTP header.

The data is returned in pages, page size being 100 triples. The pages are numbered starting from 1, and page number is defined by  parameter.

Standalone service
As the service is open source software, it is also possible to run the service on any user's server, by using the instructions provided below.

The hardware recommendations can be found in Blazegraph documentation.

If you plan to run the service against non-Wikidata Wikibase instance, please see further instructions.

Installing
In order to install the service, it is recommended that you download the full service package as a ZIP file, e.g. from Maven Central, with group ID  and artifact ID " ", or clone the source distribution at https://github.com/wikimedia/wikidata-query-rdf/ and build it with "mvn package". The package ZIP will be in the  directory under.

The package contains the Blazegraph server as a .war application, the libraries needed to run the updater service to fetch fresh data from the wikidata site, scripts to make various tasks easier, and the GUI in the  subdirectory. If you want to use the GUI, you will have to configure your HTTP server to serve it.

By default, only the SPARQL endpoint at http://localhost:9999/bigdata/namespace/wdq/sparql is configured, and the default Blazegraph GUI is available at http://localhost:9999/bigdata/. Note that in the default configuration, both are accessible only from localhost. You will need to provide external endpoints and an appropriate access control if you intend to access them from outside.

Using snapshot versions
If you want to install an un-released snapshot version (usually this is necessary if released version has a bug which is fixed but new release is not available yet) and do not want to compile your own binaries, you can use either:
 * https://github.com/wikimedia/wikidata-query-deploy - deployment repo containing production binaries. Needs  working. Check it out and do " ".
 * Archiva snapshot deployments at https://archiva.wikimedia.org/#artifact/org.wikidata.query.rdf/service - choose the latest version, then Artifacts, and select the latest package for download.

Loading data
Further install procedure is described in detail in the [Https://github.com/wikimedia/wikidata-query-rdf/blob/master/docs/getting-started.md Getting Started document] which is part of the distribution, and involves the following steps:


 * 1) Download recent RDF dump from https://dumps.wikimedia.org/wikidatawiki/entities/ (the RDF one is the one ending in  ).
 * 2) Pre-process data with the   script. This creates a set of TTL files with preprocessed data, with names like , etc. See options for the script below.
 * 3) Start Blazegraph service by running the   script.
 * 4) Load the data into the service by using  . Note that loading data is usually significantly slower than pre-processing, so you can start loading as soon as several preprocessed files are ready. Loading can be restarted from any file by using the options as described below.
 * 5) After all the data is loaded, start the Updater service by using.

Scripts
The following useful scripts are part of the distribution:

munge.sh
Pre-process data from RDF dump for loading.

Example:

loadData.sh
Load processed data into Blazegraph. Requires  to be installed.

Example:

runBlazegraph.sh
Run the Blazegraph service.

Example:

Inside the script, there are two variables that one may want to edit: DEFAULT_GLOBE=2 USER_AGENT="Wikidata Query Service; https://query.wikidata.org/"; Also, the following environment variables are checked by the script (all of them are optional):
 * 1) Q-id of the default globe
 * 1) Blazegraph HTTP User Agent for federation

runUpdate.sh
Run the Updater service.

It is recommended that the settings for the  and   options (or absence thereof) be the same for munge.sh and runUpdate.sh, otherwise data may not be updated properly.

Example:

Also, the following environment variables are checked by the script (all of them are optional):

Configurable properties
The following properties are configurable via adding them to the script run command in the scripts above:

Missing features
Below are features which are currently not supported:


 * Redirects are only represented as owl:sameAs triple, but do not express any equivalence in the data and have no special support.

Contacts
If you notice anything wrong with the service, you can contact the Discovery team by email on the list  or on the IRC channel.

Bugs can also be submitted to and tracked on the Discovery Phabricator board.