Cargo: Exporting data

From Gamepedia Help Wiki
Jump to: navigation, search
NOTE:
Prof hydra.svg Adapted from the Cargo extension documentation.


You can export the data contained in Cargo to use by other systems. There are various ways to do it: via display formats, via the API, and through direct SQL querying.

Export display formats[edit | edit source]

Queries in Cargo include three display formats that can be used for exporting data: "csv", "json" and "excel". If you set one of these as the display format, you will simply see a link as the query result. Clicking on that link will download a file (provided by the page Special:CargoExport) to the user's computer, that holds that structured data. Any outside system can also directly access that URL, if it has access to the wiki.

csv[edit | edit source]

The "csv" format has the following parameters, all optional:

  • delimiter - sets the separator character (default is comma)
  • link text - sets the text of the link (default is "View CSV", or the value at the page MediaWiki:cargo-viewcsv)
  • filename - sets the name of the file that is downloaded (default is "results.csv")

json[edit | edit source]

The "json" format has the following parameters, all optional:

  • link text - sets the text of the link (default is "View JSON", or the value at the page MediaWiki:cargo-viewjson)

excel[edit | edit source]

The "excel" format has the following parameters, all optional:

  • link text - sets the text of the link (default is "View XLS", or the value at the page MediaWiki:cargo-viewxls)
  • filename - sets the name of the file that is downloaded (default is "results.xls")

API[edit | edit source]

Cargo defines the "cargoquery" MediaWiki API action, which lets you call the equivalent of #cargo_query from an outside the wiki, returning the results in MediaWiki-specific JSON and XML formats. To see its usage syntax, search for "action=cargoquery" here.

Database querying[edit | edit source]

Finally, because Cargo stores its data in fairly simple database tables, you should be able to have other systems directly query its data using SQL, provided of course that they have access to that database. You can see an explanation of Cargo's data storage, including some special fields and tables, at Database storage details.