app:metadata:sync¶

Queue a metadata sync from the external providers for every library, or with --source=genres only the genre sync. The command does what the Trigger Sync and Sync Genres buttons on the admin metadata page do, POST /api/admin/metadata/trigger-sync in the admin API, through the same sync job.

Quick start¶

make exec cmd="php bin/console app:metadata:sync"

Run only the genre sync:

make exec cmd="php bin/console app:metadata:sync --source=genres"

Print the result as JSON, for a script:

make exec cmd="php bin/console app:metadata:sync --json"

Options¶

Details¶

Without a source, the sync queues one library sync per library. Each library sync, when a worker runs it, queues a sync of every album in the library and of its songs. Album and song data that is already filled in is kept.

The genre sync queues a sync of every album and song in the catalog with forced updates, so the providers' data, genres included, replaces what is stored. It queues nothing for the libraries.

The command runs the sync job in its own process and records the run in the job monitor like a queued job. When the job finishes, the command prints the number of jobs it queued, one per library or one per album and song, and the job ID. The queue workers perform the queued syncs; follow them with app:monitor:jobs or app:metadata:status.

With --json the command prints only {"jobsDispatched": 3, "jobId": "..."}. jobsDispatched is the API's data payload, the number of jobs queued. jobId is the job-monitor ID of the sync run, which the API does not return; pass it to app:monitor:job:show.

Exit codes¶