Extension:External Data/fr

L'extension External Data permet aux pages MediaWiki de récupérer, filtrer et formater des données structurées à partir d'une ou plusieurs sources. Ces sources peuvent inclure des URL externes, des pages de wiki régulières, des fichiers téléversés, des fichiers sur le serveur local, des bases de données et des répertoires LDAP.

Fonctions d'analyse
L'extension a neuf fonctions d'analyseur :
 * #get_web_data - récupère des données CSV, GFF, JSON, XML, HTML ou format libre à partir d'une URL et les affecte à des variables accessibles sur la page.
 * #get_soap_data - récupère les données d'une URL via le protocole SOAP.
 * #get_file_data - retrieves data from a file on the local server, in the same formats as #get_web_data.
 * #get_db_data - récupère les données d'une base de données.
 * #get_ldap_data - retrieves data from an LDAP server.
 * #external_value - displays the value of any such variable.
 * #for_external_table - parcourt toutes les valeurs récupérées pour un ensemble de variables, en affichant le même texte conteneur pour chacune d'elles.
 * #store_external_table - cycles through a table of values, storing them as semantic data via the Semantic MediaWiki extension, by mimicking a call to SMW's #subobject function for each row.
 * #display_external_table - parcourt toutes les valeurs récupérées pour un ensemble de variables, en affichant le même texte conteneur pour chacune d'elles.
 * #clear_external_data - efface l'ensemble actuel de données récupérées.

Téléchargement
You can download the External Data code, in .zip format, here.

Vous pouvez également télécharger le code directement via Git depuis le référentiel de code source MediaWiki. À partir d'une ligne de commande, vous pouvez appeler les éléments suivants :

Vous pouvez également afficher le code en ligne ici.

Installation
Pour installer cette extension, créez un répertoire ExternalData (soit en extrayant un fichier compressé ou en le téléchargeant via Git) et placez ce répertoire dans le répertoire principal de MediaWiki extensions. Exécutez  dans ce répertoire. Ensuite, dans le fichier LocalSettings.php, ajoutez la ligne suivante :

Auteurs
External Data was created, and is maintained, by Yaron Koren (reachable at yaron57@gmail.com). The overall code base, though, is the work of many people. Alexander Mashin has contributed significantly to the code. Important code contributions have also been made by Michael Dale, David Macdonald, Siebrand Mazeland, Ryan Lane, Chris Wolcott, Jelle Scholtalbers, Kostis Anagnostopoulos, Nick Lindridge, Dan Bolser, Joel Natividad, Scott Linder, Cindy Cicalese, Umherirrender, Anysite, Sahaj Khandelwal and others.

Le développement de certaines caractéristiques a été financé par KeyGene et KDZ - Zentrum für Verwaltungsforschung.

Récupération des données
Les données peuvent être extraites de trois sources différentes : à partir d'une page Web contenant des données structurées (y compris une page sur le wiki lui-même), d'une base de données ou d'un serveur LDAP.

#get_web_data - CSV, GFF, JSON, XML, HTML
Pour obtenir des données à partir d'une page Web contenant des données structurées, appelez la fonction d'analyse #get_web_data. Il peut prendre la syntaxe suivante :

Une explication des paramètres :


 * url - définit l'URL complète du fichier en cours de récupération.
 * format - specifies the format of the data being retrieved: it should be one of either 'CSV', 'CSV with header', 'GFF', 'JSON', 'XML', 'HTML' or 'text'. CSV, JSON and XML are standard data formats; GFF, or the Generic Feature Format, is a format for genomic data. The difference between 'CSV' and 'CSV with header' is that 'CSV' is simply a set of lines with values; while in ' ', the first line is a " ", holding a comma-separated list of the name of each column. 'text' indicates that the contents of the file should be retrieved as-is.
 * delimiter - spécifie le délimiteur entre les valeurs de l'ensemble de données ; il est utilisé uniquement pour les formats CSV. La valeur par défaut est  . Pour spécifier un délimiteur de tabulation, utilisez  .
 * regex - specifies a PHP regular expression that should be used to get specific strings; used with the "text" format. Example: For sample text, the regex   returns "Heading" to the external variable.
 * data - holds the "mappings" that connect local variable names to external variable names. Each mapping (of the form  ) is separated by a comma. External variable names are the names of the values in the file (in the case of a header-less CSV file, the names are simply the indexes of the values: 1, 2, 3, etc.), and local variable names are the names that are later passed in to.
 * filters - sets filtering on the set of rows being returned. You can set any number of filters, separated by commas; each filter sets a specific value for a specific external variable. It is not necessary to use any filters; most APIs, it is expected, will provide their own filtering ability through the URL's query string.
 * use xpath - an optional parameter that can be used with the "XML" or "HTML" formats, to indicate that "data" mappings should be done using XPath notation; see Using XPath, below.
 * default xmlns prefix - an optional parameter that can be used with "use xpath", which sets the default namespace prefix to be used.
 * use jsonpath - an optional parameter that can be used with the "JSON" format, to indicate that "data" mappings should be done using JSONPath notation; see Using JSONPath, below.
 * json offset - an optional parameter that represents the number of characters to ignore at the beginning of the data set being parsed. It is used with JSON values, in case the JSON being accessed has some kind of security string at the beginning.
 * post data - an optional parameter that lets you send some set of data to the URL via POST, instead of via the query string.
 * cache seconds - an optional parameter that sets the number of seconds that the values from this call should be cached; if it is less than, if there is any, the latter will apply; and if the effective cache expiration time is zero, caching is forbidden.
 * use stale cache - an optional parameter that allows this function to use an expired cache entry if it cannot retrieve the real data.
 * suppress error - an optional parameter that prevents any error message from getting displayed if there is a problem retrieving the data.

Plus d'un appel  peut être utilisé dans une page. Dans ce cas, assurez-vous que chaque nom de variable locale est unique.

Pour les données provenant de sources XML, les noms des variables sont déterminés à la fois par le noms des balises et ceux des attributs. Par exemple, avec le texte XML suivant :

the variable type would have the value Apple, and the variable color would have the value red.

De même, le texte XML suivant serait interprété comme une table de valeurs définissant deux variables nommées type et color :

Un fichier CSV doit être littéralement un fichier CSV, par exemple délimité par des virgules. Un appel pour un fichier CSV sans en-tête peut avoir l'aspect suivant :



alors qu'un appel à CSV avec une ligne d'en-tête peut ressembler à :



where the header contains, which is retrieved as   in the wiki.

Vous pouvez également définir la mise en cache à effectuer sur les données récupérées, et le remplacement de chaînes pour masquer les clés API ; voir la section Utilisation, ci-dessous, pour savoir comment faire les deux.

Obtention de données à partir d'un fichier texte non API
Si les données auxquelles vous souhaitez accéder se trouvent sur une page MediaWiki ou dans un fichier téléversé, vous pouvez utiliser les méthodes ci-dessus pour récupérer les données en supposant que la page ou le fichier contient uniquement des données dans l'un des formats pris en charge :


 * pour les données d'une page wiki, utilisez " " comme partie de l'URL;
 * for data in an uploaded file, use the full path.

If the MediaWiki page with the data is on the same wiki, it is best to use the fullurl: parser function, e.g.



Similarly, for uploaded files, you can use the filepath: function, e.g.

For wiki pages that have additional information, the External Data extension provides a way to create an API of your own, at least for CSV data. To get this working, first place the data you want accessed in its own wiki page, in CSV format, with the headers as the top row of data (see here for an example). Then, the special page 'GetData' will provide an "instant API" for accessing either certain rows of that data, or the entire table. By adding "field-name=value" to the URL, you can limit the set of rows returned.

A URL for the 'GetData' page can then be used in a call to #get_web_data, just as any other data URL would be; the data will be returned as a CSV file with a header row, so the 'format' parameter of #get_web_data should be set to 'CSV with header'. See here for an example of such data being retrieved and displayed using #get_web_data and #for_external_table. In this way, you can use any table-based data within your wiki without the need for custom programming.

Mise en cache des données
You can configure External Data to cache the data contained in the URLs that it accesses, both to speed up retrieval of values and to reduce the load on the system whose data is being accessed. To do this, you can run the SQL contained in the extension file 'ExternalData.sql' in your database, which will create the table 'ed_url_cache', then add the following to your LocalSettings.php file, after the inclusion of External Data:

Vous devez également ajouter une ligne comme suit, pour définir le temps d'expiration du cache, en secondes ; cet exemple de ligne va mettre en cache les données pendant une semaine :

By default, if data cannot be retrieved, and a cache table exists, #get_web_data will use the cached value for this data even if the cache has already expired. Pour interdire cela, ajoutez ce qui suit à LocalSettings.php :

Chaîne de remplacement dans les URL
One or more of the URLs you use may contain a string that you would prefer to keep secret, like an API key. If that's the case, you can use the array $edgStringReplacements to specify a dummy string you can use in its place. For instance, let's say you want to access the URL "http://worlddata.com/api?country=Guatemala&key=123abcd", but you don't want anyone to know your API key. You can add the following to your LocalSettings.php file, after the inclusion of External Data:

Then, in your call to #get_web_data, you can replace the real URL with: "http://worlddata.com/api?country=Guatemala&key=WORLDDATA_KEY".

Liste d'autorisation pour les URL
Vous pouvez créer une liste d'autorisation pour les URL accessibles par #get_web_data : en d'autres termes, une liste de domaines, dont seules les URL de ces domaines seront accessibles. Si vous utilisez des remplacements de chaînes afin de masquer les clés secrètes, il est fortement recommandé de créer une telle liste d'autorisation, afin d'empêcher les utilisateurs de découvrir ces clés en les incluant dans une URL dans un domaine qu'ils contrôlent.

To create a whitelist with one domain, add the following to LocalSettings.php:

Pour créer une liste d'autorisation avec plusieurs domaines, ajoutez plutôt quelque chose comme suit :

HTTP options
By default, #get_web_data allows for HTTPS-based wikis to access plain HTTP URLs, and vice versa, without the need for certificates (see Transport Layer Security on Wikipedia for a full explanation). Si vous souhaitez exiger la présence d'un certificat, ajoutez ce qui suit à LocalSettings.php :

Additionally, the global variable $edgHTTPOptions lets you set a number of other HTTP-related settings. Il s'agit d'un tableau qui peut contenir l'une des clés suivantes :


 * - how many seconds to wait for a response from the server (default is 'default', which corresponds to the value of $wgHTTPTimeout, which by default is 25)
 * - whether to verify the SSL certificate, if retrieving an HTTPS URL (default is false)
 * - whether to retrieve another URL if the specified URL redirects to it (default is false)

Ainsi, par exemple, si vous voulez vérifier le certificat SSL de n'importe quelle URL accessible par #get_web_data, vous devez ajouter ce qui suit à LocalSettings.php :

Utilisation de XPath
In some cases, the same tag or attribute name can be used more than once in an XML or HTML file, and you only want to get a specific instance of it. You can do that using the XPath notation. To do it, you just need to add the parameter "use xpath", and then have each "external variable name" in the "data=" parameter be in XPath notation, instead of just a simple name.

We won't get into the details of XPath notation here, but you can see a demonstration of "use xpath" here.

Note that, when using XPath, any specific call to #external_value seems to only work once on a page. If you need to display a specific value more than once, you can use the Variables extension to store that value and then retrieve it again later in the page.

Utilisation de JSONPath
Just as with XML (see the section above), in JSON, specifying which data you want can require more than simply specifying an attribute or tag name. Thankfully, just as XML has XPath, JSON has JSONPath: JSONPath is less well-known but just as useful. See here for one guide to JSONPath syntax, and here for an online evaluator of JSONPath syntax.

To use JSONPath, just add the parameter "use xpath" to the parser function call, and then have each "external variable name" in the "data=" parameter be in JSONPath notation.

Utilisation de sélecteurs de style CSS
With the "HTML" format, you can either use XPath (see above) or CSS-style selectors. For CSS-style selection, you do not need to specify a special parameter: it is the default approach used when "use xpath" is not specified. CSS selectors are a notation that uses tag names, classes and IDs to locate one or more elements in an HTML page; it is also the syntax used in jQuery. See here for one reference for CSS-style selectors.

#get_soap_data - données Web via SOAP
The parser function #get_soap_data, similarly to #get_web_data, lets you get data from a URL, but here using the SOAP protocol. It is called in the following way:

All of the LocalSettings.php settings that can be applied for #get_web_data can also be applied for #get_soap_data: $edgCacheTable, $edgCacheExpireTime, $edgStringReplacements, $edgAllowExternalDataFrom and $edgAllowSSL.

#get_file_data - retrieve files on the local server
You can get data from a file on the server on which the wiki resides, using #get_file_data. This parser function is called in a similar manner to #get_web_data - the set of allowed formats is the same, as are most of the other parameters. Unlike with #get_web_data, however, you cannot retrieve the data from any file; rather, the set of allowed files, and/or directories, must be set beforehand in LocalSettings.php, with an alias for each one, so that the actual file paths remain private. It is called in the following way:

Either "file=", or the combination of "directory=" and "file name=", should be set, but not both. If you want to give the wiki access to one or a small number of files, you could add one or more lines like the following to LocalSettings.php:

Vous devez ensuite définir "file=" sur l'ID de ce fichier.

Et s'il y a des répertoires à partir desquels vous voulez que le wiki puisse accéder à tous les fichiers, vous pouvez ajouter une ou plusieurs lignes comme celle-ci à LocalSettings.php :

You would then set "directory=" to the ID of that directory, and "file name=" to the name of the file you want to access in this #get_file_data call. Note that the External Data code ensures that users cannot do tricks like adding "../.." and so on to the file name to access directories outside of the specified one.

Pour donner un exemple, disons qu'un laboratoire veut publier les résultats de tests sur son wiki. Les résultats sont tous dans des fichiers CSV dans un répertoire sur un serveur. Donc, ils pourraient ajouter ce qui suit à LocalSettings.php :

Ensuite, un appel à #get_file_data sur le wiki pourrait ressembler à ceci :

En dessous, il y aurait probablement un appel à #for_external_table ou #display_external_table pour afficher les données résultantes.

#get_db_data - récupère des données à partir d'une base de données
La fonction d'analyse #get_db_data permet d'extraire des données de bases de données externes. This function executes a simple SELECT statement and assigns the results to local variables that can then be used with the #external_value or #for_external_table functions.

A note about security: - If you are going to use #get_db_data you should think about the security implications. Configuring a database in LocalSettings.php will allow anyone with edit access to your wiki to run arbitrary SQL statements against that database. You should use a database user that has the minimum permissions for what you are trying to achieve. It is possible that complex SQL constructions could be passed to this function to cause it to do things vastly different from what it was designed for.

Configuration
Chaque base de données accessible doit être configurée séparément dans LocalSettings.php. Pour les bases de données normales (tout sauf SQLite), ajoutez la strate suivante pour chaque base de données :

Where:


 * ID is a label for this database which is used when calling #get_db_data
 * server URL is the hostname on which the database lives
 * DB type is the type of database, i.e. mysql, postgres, mssql, oracle, sqlite, db2 or mongodb
 * DB name, username and password are details for accessing the database.

An example of a set of values would be:

The following optional settings can also be added:

Example values for these variables are:

Support for database systems
MySQL, Postgres (i.e. PostgreSQL), DB2 and MongoDB should work fully by default (though there are syntax limitations, and differences, for MongoDB - see below). For MS SQL/SQLServer, SQLite and Oracle, you may need to perform some special handling.

If you cannot connect to a PostgreSQL database, it may be because your PHP installation is lacking the PostgreSQL database module, php-pgsql. On many Linux systems, you can install it by calling the following, then restarting the web server: yum install php55-php-pgsql
 * Postgres

Amend the above configuration in LocalSettings.php to change the server type to "postgres":

For Microsoft SQLServer, if it doesn't work by default, there are two options that may help:
 * MS SQL/SQLServer
 * If the wiki is running on Windows, you can install Microsoft drivers for PHP for SQL Server. See instructions here.
 * If the wiki is running on Linux, the OdbcDatabase extension may help.
 * You will need to specify "odbc" (not "mssql") as the database type.
 * Note that this extension seems to have a bug in it. Thankfully, it's easy to fix: find the line that looks like "static function getSoftwareLink", and remove the word "static."

To connect to SQLite, you need something like the following in LocalSettings.php:
 * SQLite

Connecting to Oracle may work by default. If it doesn't work, the following may help:
 * Oracle
 * Make sure that the Oracle client, and the PHP version being used, are using the same architecture: they have to either both be 32-bit, or both be 64-bit.
 * Make sure that the value of $edgDBServer for the installation matches something in the corresponding Oracle client .ora files. The value may need to look like "serverName/dbName", as opposed to "serverName".
 * If none of the above are the issue, you could try using the OdbcDatabase extension, which should work as well.

For MongoDB, there are no special connection parameters, although the username and password may be optional. There are two optional query parameters:  and. Under PHP 7.*, the extension  is required.
 * MongoDB

Usage
To get data from an external database, call the following:

An explanation of the fields:


 * - the identifying label configured in LocalSettings.php
 * - an SQL "FROM" clause, i.e. one or more tables - can be as simple as  or as complex as   etc.
 * - corresponds to an SQL "JOIN ... ON" clause; used if there is more than one table being queried. An example value would be  etc.
 * - an SQL "WHERE" clause (optional)
 * - an SQL "LIMIT" clause, i.e. a number, limiting the number of results (optional)
 * - an SQL "ORDER BY" clause (optional)
 * - mapping of database column names to local variables (syntax: localVariable=databaseColumn - i.e. "employeeName" is the name of the database column in the example below).
 * - prevents any error message from getting displayed if there is a problem retrieving the data (optional)

An example call, using the "employee database" example from above:

MongoDB
MongoDB is a non-SQL (or "NoSQL", if you prefer) database system, with its own querying language. When accessing MongoDB, you can either pass in a standard MongoDB query, or use the standard SQL-like syntax of #get_db_data. To use standard MongoDB querying, pass the query to the parameter  or.

You can also use the standard querying functionality. There are some restrictions and differences, however, for the "where" clause:
 * only "AND"s can be used, not "OR"s
 * for the "LIKE" comparison, no text should be placed around the comparator - it should look like "Username LIKE Jo", not "Username LIKE '%Jo%'".

Because MongoDB returns values in JSON that may be complex, and contain compound values, you can get data that is stored in such a way by separating field names with dots. For instance, if the return data contains a value for a field called "Measurements" that is an array, holding values for fields called "Height" and "Width", then the "data=" parameter to #get_web_data could have a value like "height=Measurements.Height,width=Measurements.Width".

You can do Memcached-based caching of values retrieved from MongoDB; to do that, you need the following two lines in LocalSettings.php:

To enable ModgoDB under PHP 7.4,  extension should be enabled (and also   library should be installed with Composer:   (this will be necessary until bug T259743 is resolved).

#get_ldap_data - retrieve data from LDAP directory
The parser function #get_ldap_data allows retrieval of data from external LDAP directories. This function executes LDAP queries and assigns the results to local variables that can then be used with the #external_value function.

A note about security: - If you are going to use #get_ldap_data you should think hard about the security implications. Configuring an LDAP server in LocalSettings.php will allow anyone with edit access to your wiki to run queries against that server. You should use a domain user that has the minimum permissions for what you are trying to achieve. Wiki users could run queries to extract all sorts of information about your domain. You should know what you are doing before enabling this function.

Configuration
The PHP extension  must be enabled. You need to configure each LDAP server in LocalSettings.php. Add the following stanza for each server:

Where:


 * domain is a label to be used when calling #get_ldap_data
 * myDomainuser and myDomainPassword are credentials used to bind to the LDAP server
 * [basedn] is the base DN used for the search.

Example:

Usage
To query the LDAP server, add this call to a wiki page:

Where:


 * domain is the label used in LocalSettings.php
 * filter is the LDAP filter used for the search
 * data is the mappings of LDAP attributes to local variables
 * if all is not added, the query will retrieve only one result.

An example that retrieves a user from with Win2003/AD, using a userid passed to a template:

Displaying data
Once you have retrieved the data onto the page, from any source, there are two ways to display it on the page:  and.

Displaying individual values
If this call retrieved a single value for each variable specified, you can call the following:

As an example, this page contains the following text:

.
 * Germany borders the following countries:
 * Germany has population.
 * Germany has area.
 * Its capital is.

The page gets data from this URL, which contains the following text:

"357,050 km²","Austria,Belgium,Czech Republic,Denmark,France,Luxembourg,Netherlands,Poland,Switzerland",Berlin,"82,411,001"

The page then uses #external_value to display the 'bordered countries' and 'population' values; although it uses the #arraymap function, defined by the Page Forms extension, to apply some transformations to the 'bordered countries' value (you can ignore this detail if you want).

By default, #external_value displays an error message if it is called for a variable that has not been set, or if the specified data source is inaccessible, or the data source does not contain any data. You can disable the error message by adding the following to LocalSettings.php:

Displaying a table of values
The data returned by #get_web_data or #get_db_data (#get_ldap_data without the  parameter doesn't support this feature) can also be a "table" of data (many values per field), instead of just a single "row" (one value per field). In this case, you can display it using one of either the functions #for_external_table or #display_external_table.

#for_external_table
This URL contains information similar to that above, but for a few countries instead of just one. Calling #get_web_data with this URL, with the same format as above, will set the local variables to contain arrays of data, rather than single values. You can then call #for_external_table, which has the following format:

...where "expression" is a string that contains one or more variable names, surrounded by triple brackets. This string is then displayed for each retrieved "row" of data.

For an example, this page contains a call to #get_web_data for the URL mentioned above, followed by this call:

The call to #for_external_table holds a single row of a table, in wiki-text; it's surrounded by wiki-text to create the top and bottom of the table. The presence of " | " is a standard MediaWiki trick to display pipes from within parser functions. There are much easier calls to #for_external_table that can be made, if you just want to display a line of text per data "row", but an HTML table is the standard approach.

There's one other interesting feature of #for_external_table, which is that it lets you modify specific values. You can URL-encode values by calling them with instead of just , and similarly you can HTML-encode values by calling them with.

As an example of the former, if you wanted to show links to Google searches on a set of terms retrieved, you could call:

This is required because standard parser functions can't be used within #for_external_table - so the following, for example, will not work:

#display_external_table
This function is called as:
 * 1) display_external_table is similar in concept to #for_external_table, but it passes the values in each row to a template, which handles the display.

An explanation of the parameters:
 * - the name of the template into which each "row" of data will be passed
 * - the data mappings between external variable and local template parameter; much like the  parameters for the other functions
 * - the separator used between one template call and the next; default is a newline. (To include newlines in the delimiter value, use "\n".)
 * - a template displayed before the results set, only if there are any results
 * - a template displayed after the results set, only if there are any results

For example, to display the data from the previous example in a table as before, you could create a template called "Country info row", that had the parameters "Country name", "Countries bordered", "Population" and "Area", and then call the following:

The template "Country info row" should then contain wikitext like the following:

Clearing data
You can also clear all external data that has already been retrieved, so that it doesn't conflict with calls to retrieve external data further down the page. The most likely case in which this is useful is when data is retrieved and displayed in a template that is called more than once on a page. To clear the data, just call " ". Note that the ":" has to be there at the end of the call, or else MediaWiki will ignore the parser function.

There is no way to clear the values for only one field; #clear_external_data erases the entire set of data.

Storing data
You can also use External Data to store a table of data that has been retrieved; you can do this using the storage capabilities of either the Semantic MediaWiki or Cargo extensions. Once the data has been stored, it can then be queried, aggregated, displayed etc. on the wiki by that extension.

Semantic MediaWiki
If you store data with Semantic MediaWiki, you should note a common problem, which is that the data stored by SMW does not get automatically updated when the data coming from the external source changes. The best solution for this, assuming you expect the data to change over time, is to create a cron job to call the SMW maintenance script "rebuildData.php" at regular intervals, such as once a day; that way, the data is never more than a day old.

To store a table of data using SMW, you can use the #store_external_table function. This function works as a hybrid of the #for_external_table function and the #subobject function, defined in the Semantic MediaWiki extension. Unlike with #subobject, the first parameter is the name of a property that will link from the subobject to the page it's on. You can see a demonstration of this function on the page Fruits semantic data; the call to #store_external_table on that page looks like:
 * 1) store_external_table loops over each row, and uses variables, in the same way as #for_external_table.

Cargo
There is no special parser function for storing data via Cargo; instead you should simply use #display_external_table, and include Cargo storage code within the template called by that function. You can see an example of Cargo-based storage using #display_external_table here; it uses this template, and you can see the resulting data here.

Scribunto/Lua
Since version 2.2, External Data defines Lua functions that match the functionality of its five "accessor" parser functions, so that wikis that have the Scribunto extension installed can call these functions directly in order to access and display outside data.

The following functions are defined:

The Lua functions accept the same parameters as parser functions, but please note the following:


 * Technically, there is only one parameter; it is known in Lua as a table, and its keys correspond to the parser function parameters.
 * Comma-separated lists like  can be replaced with Lua tables; so that both   and   will work.
 * "Valueless" parameters like  can be supplied both as numbered and named:   and   are both valid.
 * Parameters whose name contains a space, like, need to be surrounded with quotes and brackets, like  , unless they are valueless, in which case quotes are enough.

Each Lua function returns two values:


 * 1) A table of external data. Unlike with the parser functions, it will be "row-based", i.e. a numbered array of records with named fields corresponding to external variables. If external data is not fetched, nil will be returned.
 * 2) * If there is only one value for some external variable (it will be in the first record), it will be duplicated as a named field of the returned table, as it is highly likely that it belongs to the rowset as a whole rather than its first row; so that it can be accessed both as  and.
 * 3) A numbered table of error messages. If there were no errors, nil will be returned.

Unlike parser functions, external data is only returned to calling Lua module and not stored on the page to be retrieved later by, etc.

Example:

Common problems

 * If the call to #get_web_data or #for_external_table isn't returning any data, and the page being accessed is large, it could be because the call to retrieve is getting timed out. You should set the flag in your LocalSettings.php file (which represents a number of seconds) to some number greater than 25, its default value. You could call, for instance:




 * If the data being accessed has changed, but the wiki page accessing it still shows the old data, it is because that page is being cached by MediaWiki. There are several solutions to this: if you are an administrator, you can hit the "refresh" tab above the page, which will purge the cache. You can also easily disable caching for the entire wiki; see here for how. Finally, if you wait long enough (typically no more than 24 hours), the page will get refreshed on its own and display the new data.


 * If you host a private wiki locally but use a dynamic IP service to access it, your wiki will connect to itself through your public IP and not through localhost or 127.0.0.1 (or an IPv6 equivalent). In such a case, your wiki is not allowed to query itself so the examples given here will work when data are hosted on a different server but not if they are hosted on your wiki. A workaround is to use the extension Extension:NetworkAuth which allows you to automatically authenticate your router/box/modem to access your wiki. Note: the security of this approach is not guaranteed.


 * If the extension is not correctly handling non-ASCII characters, the problem might be that your PHP instance lacks the mbstring extension - make sure that it is installed.


 * To query data from another wiki that uses Semantic MediaWiki, it is recommended to use the Special:Ask page, rather than one of SMW's API actions, to construct the URL that will be passed in to #get_web_data, since the API will not output data in a syntax that External Data can use. To construct the URL, go to Special:Ask, create the desired query, then copy the URL from the "Download queried results in CSV format" link.

Version history
External Data is currently at version 2.4.1. See the entire version history.

Bugs and feature requests
The best place to report bugs is on Phabricator - see How to report a bug. The project that should be specified is MediaWiki-extensions-ExternalData.

You can also put any questions, suggestions or bug reports about External Data at the talk page for this extension. Or you can write to the MediaWiki mailing list, mediawiki-l. (If you write to the mailing list, please include "External Data" somewhere in the subject line.)

You can also send specific code patches to Yaron Koren, at yaron57@gmail.com.

Translating
Translation of External Data is done through translatewiki.net. The translation for this extension can be found here. To add language values or change existing ones, you should create an account on translatewiki.net, then request permission from the administrators to translate a certain language or languages on this page (this is a very simple process). Once you have permission for a given language, you can log in and add or edit whatever messages you want to in that language.