Skip to content

Exporting Data

Sonar Catalog supports exporting data through the plugin hook system. Built-in formats:

FormatDescriptionUse Case
csvComma-separated valuesSpreadsheets, data analysis
geojsonGeoJSON FeatureCollectionGIS tools (QGIS, ArcGIS)
jsonJSON arrayScripting, custom processing
Terminal window
sonar-catalog export --list-formats

Plugins can add additional export formats (e.g., Shapefile, KML).

Terminal window
sonar-catalog export --format csv --output catalog.csv
Terminal window
sonar-catalog export --format geojson --geo --output survey_tracks.geojson

The --geo flag exports geographic point data (files with nav tracks) instead of the full file listing.

Terminal window
sonar-catalog export --format json

Omit --output to write to stdout, useful for piping:

Terminal window
sonar-catalog export --format json | jq '.[] | select(.sonar_format == "xtf")'
Terminal window
sonar-catalog export --format csv --limit 1000

The GeoJSON export produces a FeatureCollection compatible with any GIS tool:

{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [3.456, 56.123]
},
"properties": {
"content_hash": "abc123...",
"file_name": "line_001.xtf",
"file_size": 524288000,
"sonar_format": "xtf",
"nfs_server": "sonar-nas-01"
}
}
]
}

Plugins can register new export formats via the export_data and get_export_formats hooks. See Writing a Plugin.