Pause, resume or run a plugin's connector

See what a plugin's connector has been asked to do, pause it without removing anything, and ask it to run now instead of waiting for its schedule.

Marfa stores what you ask of a plugin's connector, and the connector and its host follow it: Marfa starts and stops nothing itself. A connector that doesn't read these choices carries on as before. Each command needs connectors.manage.

Check it

Terminal
marfa plugins status rss
rss's connector: running as scheduled; host Studio Mac; mapping version 1; 0 rewrites and 0 previews waiting

The line says whether the connector is paused, asked to run at a time, or running as scheduled, then the host it runs on, the version of its mapping, and the rewrites and previews it hasn't carried out yet. The connector's own key reads the same answer.

Pause and resume it

marfa plugins pause rss
marfa plugins resume rss

A paused connector stops itself, and its host doesn't start it. Pausing removes nothing: its key, settings, mapping and items stay, and a run under way finishes, because Marfa still takes its writes. Pausing also drops a run you asked for, so resuming doesn't start one.

Run it now

marfa plugins run rss

The connector runs on its next look instead of waiting for its schedule. Asking twice before it looks still gives one run. When it reports the run, the request clears and marfa plugins status says running as scheduled again. A paused connector is refused with connector_paused: resume it first.

The audit log records each choice as connector.pause, connector.resume and connector.run_request. Removing the plugin removes them. The rules are in the plugins chapter of the contract, under Pausing and running a connector, and the operations start at Get a connector's state.

On this page