Page MenuHomePhabricator

Not possible to set API-reported Wiki ID to anything other than database name
Open, Needs TriagePublic


From "The wiki ID (or database ID) is the most common way of identifying a wiki within a wiki farm in MediaWiki. When every wiki is in a separate database, it is simply the database name; when multiple wikis share a database and are differentiated with table prefixes, it is in the form <db name>-<table prefix>. It can be retrieved by calling wfWikiID()."

Back in the days before Wikibase, no one external to the server much cared what the database was named internally. The database name might have been exposed as the prefix to a few cookies, overrideable by$wgCookiePrefix but otherwise didn't affect much of anything.

Wikibase introduced the concept of a GlobalID (such as 'dewikivoyage' or 'enwiki') being publicly displayed every time an inter-language link was created on a Wikidata-style repository. The WikiID reported by the API was suddenly important, as the API was being queried in various places, including the Wikibase repository extension (when a new inter-language link is supplied by the user, to see if the page exists) and the Pywikibot extension (for functionality like - which imports inter-language links).

The presumption was that the WikiID matches the GlobalID matches the database name and prefix. Worse yet, the idea that the hard-coded global naming convention was a language code (such as 'pt') followed by a project name which began in 'wiki*' or 'wiktionary' ( see ) might have made sense on Wikimedia's cluster (where the databases happened to have those names already) but almost always didn't match the existing database names on other, non-Wikimedia projects.

There is a configuration setting in the Wikibase extension, $wgWBRepoSettings['localClientDatabases'][(...GlobalID...)]=...database name...; which does a translation from GlobalID to database name, but only within the Wikibase code and only in one direction (GlobalID to database name). There is no corresponding translation in the opposite direction - as that would have to be part of the API, which is core code.

If my existing internal database names look like "myproject_xx" and "myproject_xy" for language xx: and xy: (which are not mutually intelligible) but the GlobalID's for the projects were xxmyproject and xymyproject (because Wikibase seems to be expecting everything to follow WMF-like naming conventions) then there's no way (at least in MW 1.31) to force the API to report the proper GlobalID short of changing includes/api/ApiQuerySiteinfo.php protected function appendGeneralInfo( $property ) to make the substitution
(from MW1.31, insert after line 247): $wikiid = wfWikiID();
this kludge to report in the WikiID field the externally-known 'GlobalID' to ensure compatibility with

if (substr($wikiid,0,10)=='myproject_')
        $wikiid=substr($wikiid,10) . 'myproject';

The only other alternative is to rename every existing database so that the database name is forced to be the externally-reported GlobalID. That's doable, but it seems a bit inconsistent that a translation table like $wgWBRepoSettings['localClientDatabases'][] exists in some portions of the code but not others. Effectively, the use of $wgWBRepoSettings['localClientDatabases'][] to match GlobalID's to dissimilar local database names does not work, as the underlying database name is still being externally reported by the API. The database name and prefix must therefore still match the GlobalID, or things (such as Pywikibot's break.

Event Timeline

Carlb created this task.Apr 22 2019, 3:39 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptApr 22 2019, 3:39 PM
Carlb updated the task description. (Show Details)Apr 22 2019, 3:45 PM
Carlb added a comment.Apr 22 2019, 3:51 PM

Perhaps the easiest solution would be to create one more LocalSettings.php variable, maybe $wgGlobalID = 'xymyproject' or something similar, and return that in the 'WikiID' field from the API if it's been set instead of reporting the internal WikiID() ?

// add $wgGlobalID setting to LocalSettings.php to kludge-fix issues where database name differs from GlobalID

$wikiid = wfWikiID();
if (isset($wgGlobalID))
$data['wikiid'] = $wikiid;

// ...

Aklapper renamed this task from There appears to be no way to set the API-reported WikiID to be something/anything other than the database name to Not possible to set API-reported Wiki ID to anything other than database name.Apr 22 2019, 3:55 PM
Carlb updated the task description. (Show Details)Apr 22 2019, 4:08 PM
Anomie moved this task from Unsorted to Blocked on the MediaWiki-API board.Apr 26 2019, 6:38 PM
Anomie added a subscriber: Anomie.

As far as MediaWiki-API is concerned, this is blocked on someone moving this "global ID" concept into core and probably having wfWikiID() itself return that ID. If that were done, the API would follow naturally.

I'd recommend you see if someone from Wikidata would be interested in doing that move.

Aklapper removed a subscriber: Anomie.Oct 16 2020, 5:01 PM
Restricted Application added a project: Platform Engineering. · View Herald TranscriptOct 16 2020, 5:01 PM