Help:Maintenance script "rebuildData.php"
|Allows to rebuild all the semantic data for a selected data backend/store|
|Provided by:||Semantic MediaWiki|
|Removed:||still in use|
|Table of Contents|
The "rebuildData.php" maintenance script recreates all the semantic data in the database, by cycling through all the pages that might have semantic data, and calling functions that re-save semantic data for each one.
This script is a command line tool, while special page "SemanticMediaWiki" (formerly known as special page "SMWAdmin") data rebuilding (repair) uses the job queue to process all pages. If possible use this maintenance script for data rebuilding. See also the help page on using special page "SemanticMediaWiki" for data rebuilding.
- This maintenance script deprecated the former "SMW_refreshData.php" script starting with Semantic MediaWiki 1.9.2 while options and usage at that time remain the same.
- Note: It is strongly encouraged to make the transition to this new script to take advantage of the new features added since and because the old one will be removed with the release of Semantic MediaWiki 3.0 in late 2017.
- Starting with Semantic MediaWiki 2.2.0 the properties are always being rebuilt first every time this maintenance script is run and no matter what options are chosen.1
- If SMW is not installed in its standard path then the "MW_INSTALL_PATH" environment variable must be set. See README in the maintenance directory.
php rebuildData.php [-d|-s|-e|-n|--startidfile|-b|-v|-c|-p|-t|--page|--redirects|--query|-f|--no-cache|--report-runtime|--debug|--skip-properties|--shallow-update|--ignore-exceptions|--exception-log|--with-maintenance-log]
||Display this help message|
||Whether to supress non-error output|
||Location of "LocalSettings.php", if not in the default location (see also this thread)|
||For specifying the wiki ID|
||Output globals at the end of processing for debugging|
||Set a specific memory limit for the script, "max" for no limit or "default" to avoid changing it|
||The protocol and server name to use in URLs, e.g. https://www.semantic-mediawiki.org. This is sometimes necessary because server name detection may fail in command line scripts.|
Script dependent parameters
||The DB user to use for this script|
||The password to use for this script|
Script specific parameters
||Wait for this many milliseconds after processing an article. Useful for limiting server load.|
||Start refreshing at given object ID. Useful for partial refreshing.|
||Stop refreshing at given object ID. Useful for partial refreshing.|
||Stop refreshing after processing a given number of IDs. Useful for partial refreshing.|
||Read <startid> from a file instead of the arguments and write the next ID to the file when finished. Useful for continual partial refreshing from cron.|
||Execute the operation for the storage backend of the given name (default is to use the current data backend/store)|
||Be verbose about the progress.|
||Will refresh only category pages (and other explicitly named namespaces).|
||Will refresh only property pages (and other explicitly named namespaces)|
||Will refresh only type pages (and other explicitly named namespaces)|
|| used as a separator. |
Note: The options
||Will refresh only the pages which are redirecting to another page. Available since Semantic MediaWiki 188.8.131.52|
|| Will refresh only pages returned by a given query. Available since Semantic MediaWiki 184.108.40.206 |
Note: The options
||Fully delete all content instead of just refreshing relevant entries. This will also rebuild the whole storage structure. May leave the wiki temporarily incomplete.|
|| Sets the |
|| Will return memory usage and runtime of the respective script execution. Available since Semantic MediaWiki 2.1.0 as |
||Sets global variables to support debug ouput while running. Available since Semantic MediaWiki 220.127.116.11|
||Is to skip the default properties rebuild (only recommended when successive build steps are used). Available since Semantic MediaWiki 18.104.22.168|
||As option is to parse only those entities that have a different last modified timestamp compared to that of its last revision and should only be used to run a quick update on deleted, redirects, and other out of sync entities. Available since Semantic MediaWiki 22.214.171.124|
|| Allows to ignore encountered exceptions, i.e. the script does not stop as soon as an exception (error) appears. Available since Semantic MediaWiki 126.96.36.199 |
Note: This option is best used together with the
|| Writes exceptions (errors) encountered to a log file allowing for later debugging. Available since Semantic MediaWiki 188.8.131.52 |
Note: A file name is automatically being created containing the string "logrebuilddata-exceptions" and the timestamp (ISO format), e.g. "logrebuilddata-exceptions-2016-12-05.log". In case an unambiguous name is needed just add an identifier to the option, e.g.
||Adds a log entry to "Special:Logs" on the wiki and reports the script's runtime. Available since Semantic MediaWiki 184.108.40.206|
The progress (starting with Semantic MediaWiki 2.3.0) that is displayed during a rebuild process is self-adjusting based in the amount of expected ID's vs. the actual amount of ID's being processed.13 Due to each entity (i.e. subobject, property, and subject) being assigned an ID it does not necessarily correspond to the page ID of MediaWiki as various types of subobjects embedded in a page are assigned an ID as well.
Especially in case of a full rebuild (
-f) is the progress slanting where the start amount is lower than the final ID count (which is predicted from the MediaWiki articles count).
............................................................ 10% ............................................................ 9% ............................................................ 9% ............................................................ 8% ............................................................ 9% ............................................................ 10%
Quick and slow progress
ID's assigned to a "real" page are parsed using MW's Parser to ensure that all data and extensions influencing the state of the data are being accounted for which amounts to the extensive memory and time effort required to finalize a full parse of a page including all #subobject, #ask plus any other embedded parser function calls.14
ID's that represent data items such as subobjects or value objects can be processed using Semantic MediaWiki internal functions hence the comparatively quick update progress.
The verbose output (
-v) got extended2 in Semantic MediaWiki 2.4.0 to display additional information about an entity that is being processed. The marker
* identifies a regular MediaWiki page with the ID corresponding to the
page table entry while non-marked ID's are matched to an entry in the
(4/796) Finished processing ID 5* (Berlin) (5/796) Finished processing ID 6* (London) (6/796) Finished processing ID 7* (Lorem_ipsum) (7/796) Finished processing ID 8* (John_Doe) (7/796) Finished processing ID 8 (Property:Display_units)
Marked for deletion entries
Removing marked for deletion entries. .. 2 IDs removed.
Dispose of outdated object ID references
Starting with Semantic MediaWiki 2.4.0 outdated object ID references are disposed when running "rebuildData.php".15 When the data type of a property type is changed, a property is removed or other object values are deleted chances are that some ID's remain in the
ID_TABLE of the database.16 To avoid a pile of garbage references being collected in this database table it is checked if for the ID's whether they can safely be removed or not during the "rebuidData.php" run. This is best and frequently done using the
- The following command refreshes existing semantic data items with a delay of 50 ms between every data item without prompting progress information.
php rebuildData.php -d 50 -q
- The following command verbosely rebuilds semantic data after deleting existing items with a delay of 100 ms between every data item.
php rebuildData.php -f -d 100 -v
- The following command verbosely rebuilds semantic data of pages in a given category.
php rebuildData.php --query='[[Category:SomeCategory]]' -v
- The following command verbosely rebuilds semantic data with a delay of 75 ms between every data item and provides memory usage information after it has been completed.
php rebuildData.php -d 75 --report-runtime
- Example output:
Memory used: 25543928 (b: 11429464, a: 36973392) with a runtime of 81.62 sec (1.36 min)
- a) memory used after execution and b) memory used before the execution
- The following command refreshes the wiki pages "Page 1" and "Page 2" without prompting progress information.
php rebuildData.php --page="Page 1|Page 2"
- The following command rebuilds semantic data with a delay of 50 ms between every data item, ignores errors which may arise during execution and writes them to a file in the directory provided.
php rebuildData.php -d 50 --ignore-exceptions --exception-log="/var/log/mediawiki/"
- Exceptions are e.g written to the "mywiki.logrebuilddata-exceptions-2016-08-14.log" file if the wiki ID was "mywiki" and the script was run on August 14, 2016.
- The following command quietly removes just the outdated entities.17
rebuildData.php --skip-properties -s 1 -e 1 --quiet
There was some discussion on the mailing list about the occasions it is required to run this maintenance script.18
Help:rebuildData.php en 1.9.2
- Semantic MediaWiki: GitHub issue #877
- Semantic MediaWiki: GitHub pull request #1433
- Semantic MediaWiki: GitHub pull request #1127
- Semantic MediaWiki: GitHub pull request #243
- Semantic MediaWiki: GitHub issue #749
- Semantic MediaWiki: GitHub issue #643
- Semantic MediaWiki: GitHub commit 68e8bc9
- Semantic MediaWiki: GitHub issue #766
- Semantic MediaWiki: GitHub pull request #1106
- Semantic MediaWiki: GitHub pull request #1361
- Semantic MediaWiki: GitHub issue #1983
- Semantic MediaWiki: GitHub pull request #1985
- Semantic MediaWiki: GitHub pull request #1042
- Semantic MediaWiki: GitHub issue #1698: Can we make `rebuildData` to operate faster?
- Semantic MediaWiki: GitHub pull request #1216
- Semantic MediaWiki: GitHub issue #498
- Semantic MediaWiki: GitHub issue #1754 comment
- Semantic MediaWiki: User mailing list thread "When is it required to run rebuildData.php"