CLI viide

Vaata Markdownina Muuda teenuses GitHub Dokumentatsioon: 2cc7b2b

Kõik Queuety toimingud on vaikimisi saadaval WP-CLI kaudu nimeruumis wp queuety.

Määratlege QUEUETY_CLI_COMMAND enne Queuety käivitumist, kui soovite avaldada sama käsupuu muu juure all, näiteks wp themequeue.

Agendi töökeskkondade ja muude virtuaalse bashi integratsioonide puhul käsitlege seda lehte inimloetava juhendina ning kasutage PHP sildu masinliidesena:

Queuety::cli_command_map() pakub serialiseeritavat käskude kataloogi
Queuety::resolve_cli_command( $path, $args, $assoc_args ) teisendab parsitud wp queuety ... sisendi normaliseeritud täitmisplaaniks, mis eelistab otseseid PHP väljakutsutavaid objekte

Selles puus pole olekumasinatel käske; uurige neid PHP API kaudu, mida kirjeldatakse jaotises Olekumasinad.

Tööde käsud

`wp queuety work`

Käivitab töötaja, mis töötleb töid.

Shell

wp queuety work [--queue=<queue>] [--once] [--workers=<n>]
wp queuety work [--queue=<queue>] [--min-workers=<n>] --max-workers=<n>

Suvand	Kirjeldus
`--queue=<queue>`	Töödeldavad Queue(s), prioriteetsuse määramiseks komadega eraldatult (vaikimisi: `default`)
`--once`	Töötleb kõige rohkem ühe töö ja väljub (väljub kohe ka siis, kui ühtegi tööd ei saa hõivata)
`--workers=<n>`	Käivitab N töötajaprotsessi (vajab laiendusi `pcntl` ja `posix`, nagu ka `--min-workers` ja `--max-workers`)
`--min-workers=<n>`	Kohanduva kogumi töötajate minimaalne arv. Vajab `--max-workers`
`--max-workers=<n>`	Kohanduva kogumi töötajate maksimaalne arv

Shell

# Single worker on default queue
wp queuety work

# Process a specific queue
wp queuety work --queue=emails

# Process multiple queues in priority order
wp queuety work --queue=critical,default,low

# One-shot mode
wp queuety work --once

# Multi-worker mode
wp queuety work --workers=4

# Adaptive worker pool
wp queuety work --queue=providers --min-workers=2 --max-workers=6

Mitme järjekorra määramisel püüab töötaja hõivata töö igast järjekorrast loetletud järjekorras. Võidab esimene järjekord, kus on saadaval töö. --workers hoiab kogumi suuruse muutumatuna. --min-workers ja --max-workers lubavad sama käsustiku puhul kohanduvat skaleerimist. Juurutusstrateegiaid vt jaotisest Töötajad ning kohanduvate kogumite vastuvõtumudelit jaotisest Ressursside haldus.

`wp queuety flush`

Töötleb kõik ootel tööd ja väljub.

Shell

wp queuety flush [--queue=<queue>]

Suvand	Kirjeldus
`--queue=<queue>`	Tühjendatavad Queue(s), prioriteetsuse määramiseks komadega eraldatult (vaikimisi: `default`)

Shell

# Flush a single queue
wp queuety flush --queue=emails

# Flush multiple queues in priority order
wp queuety flush --queue=critical,default,low

`wp queuety dispatch`

Saadab töö käsurealt täitmisele.

Shell

wp queuety dispatch <handler> [--payload=<json>] [--queue=<queue>] [--priority=<priority>] [--delay=<seconds>]

Suvand	Kirjeldus
`<handler>`	Töötleja nimi või klass (nõutav)
`--payload=<json>`	JSON koormus (vaikimisi: `{}`)
`--queue=<queue>`	Järjekorra nimi (vaikimisi: `default`)
`--priority=<priority>`	Prioriteeditase 0-3 (vaikimisi: `0`)
`--delay=<seconds>`	Viivitus sekundites (vaikimisi: `0`)

Shell

wp queuety dispatch send_email --payload='{"to":"user@example.com"}' --queue=emails

`wp queuety status`

Kuvab järjekorra statistikat.

Shell

wp queuety status [--queue=<queue>]

Suvand	Kirjeldus
`--queue=<queue>`	Filtreerib järjekorra nime järgi

`wp queuety list`

Loetleb tööd.

Shell

wp queuety list [--queue=<queue>] [--status=<status>] [--format=<format>]

Suvand	Kirjeldus
`--queue=<queue>`	Filtreerib järjekorra järgi
`--status=<status>`	Filtreerib oleku järgi (`pending`, `processing`, `completed`, `failed`, `buried`)
`--format=<format>`	Väljundvorming: `table` (vaikimisi), `json`, `csv`, `yaml`

`wp queuety inspect`

Kuvab töö täielikud üksikasjad, sealhulgas koormuse ja logiajaloo.

Shell

wp queuety inspect <id>

Suvand	Kirjeldus
`<id>`	Töö ID (nõutav)

`wp queuety retry`

Proovib kindlat tööd uuesti.

Shell

wp queuety retry <id>

Suvand	Kirjeldus
`<id>`	Uuesti proovitava töö ID (nõutav)

`wp queuety retry-buried`

Proovib kõiki maetud töid uuesti.

Shell

wp queuety retry-buried

`wp queuety bury`

Matab töö käsitsi.

Shell

wp queuety bury <id>

Suvand	Kirjeldus
`<id>`	Maetava töö ID (nõutav)

`wp queuety delete`

Kustutab töö.

Shell

wp queuety delete <id>

Suvand	Kirjeldus
`<id>`	Kustutatava töö ID (nõutav)

`wp queuety recover`

Taastab aegunud tööd, mis on olekus processing.

Shell

wp queuety recover

`wp queuety purge`

Kustutab lõpetatud tööd.

Shell

wp queuety purge [--older-than=<days>]

Suvand	Kirjeldus
`--older-than=<days>`	Kustutab N päevast vanemad tööd (vaikimisi: `QUEUETY_RETENTION_DAYS`)

`wp queuety pause`

Peata järjekord, et töötajad selle vahele jätaksid.

Shell

wp queuety pause <queue>

Suvand	Kirjeldus
`<queue>`	Peatatava järjekorra nimi (nõutav)

`wp queuety resume`

Jätka peatatud järjekorda.

Shell

wp queuety resume <queue>

Suvand	Kirjeldus
`<queue>`	Jätkatava järjekorra nimi (nõutav)

`wp queuety metrics`

Kuvab töötlejapõhiseid mõõdikuid.

Shell

wp queuety metrics [--minutes=<minutes>] [--format=<format>]

Suvand	Kirjeldus
`--minutes=<minutes>`	Ajavahemik minutites (vaikimisi: `60`)
`--format=<format>`	Väljundvorming: `table` (vaikimisi), `json`, `csv`, `yaml`

`wp queuety discover`

Avastab kataloogis töötlejaklasse.

Shell

wp queuety discover <directory> <namespace> [--register]

Suvand	Kirjeldus
`<directory>`	Kataloog, kust töötlejaklasse otsida (nõutav)
`<namespace>`	Kataloogi PSR-4 nimeruumi prefiks (nõutav)
`--register`	Registreerib leitud töötlejad päriselt

Töövoo käsud

`wp queuety workflow status`

Kuvab töövoo oleku ja edenemise.

Shell

wp queuety workflow status <id>

Suvand	Kirjeldus
`<id>`	Töövoo ID (nõutav)

status kuvab praeguse sammu, valikulise sammunime, versiooni ja räsi metaandmed, ooteviisi, artefaktide kokkuvõtte ning WaitInfo JSON andmeploki, kui töövoog ootab parajasti signaale või sõltuvusi.

`wp queuety workflow list`

Loetleb töövood.

Shell

wp queuety workflow list [--status=<status>] [--format=<format>]

Suvand	Kirjeldus
`--status=<status>`	Filtreerib oleku järgi: `running`, `completed`, `failed`, `paused`, `waiting_for_signal`, `waiting_for_workflows`, `cancelled`
`--format=<format>`	Väljundvorming: `table` (vaikimisi), `json`, `csv`, `yaml`

Käsk tagastab kuni 50 töövoogu. See loeb väärtust --limit, kuid WP-CLI lükkab lipu praegu tagasi, sest käsk ei deklareeri seda (#12); teistsuguse limiidi määramiseks kasutage väärtust Queuety::list_workflows().

Vaiketabel sisaldab väärtusi StepName ja WaitMode, et blokeeritud töövooge oleks lihtsam üle vaadata.

`wp queuety workflow retry`

Käivitage ebaõnnestunud töövoog uuesti alates ebaõnnestunud sammust.

Shell

wp queuety workflow retry <id>

Suvand	Kirjeldus
`<id>`	Töövoo ID (nõutav)

`wp queuety workflow approve`

Saadab töövoole kinnitussignaali.

Shell

wp queuety workflow approve <id> [--data=<json>] [--signal=<name>]

Suvand	Kirjeldus
`<id>`	Töövoo ID (nõutav)
`--data=<json>`	Valikuline JSON tüüpi koormusobjekt
`--signal=<name>`	Alistab kinnitussignaali nime (vaikimisi: `approval`, mis vastab väärtusele `wait_for_approval()`; samm `wait_for_decision()` ootab vaikimisi väärtust `approved`, seega edastage seal väärtus `--signal=approved`)

`wp queuety workflow reject`

Saadab töövoole tagasilükkamissignaali.

Shell

wp queuety workflow reject <id> [--data=<json>] [--signal=<name>]

Suvand	Kirjeldus
`<id>`	Töövoo ID (nõutav)
`--data=<json>`	Valikuline JSON tüüpi koormusobjekt
`--signal=<name>`	Alistab tagasilükkamissignaali nime (vaikimisi: `rejected`)

`wp queuety workflow input`

Saadab töövoole struktureeritud sisendi.

Shell

wp queuety workflow input <id> [--data=<json>] [--signal=<name>]

Suvand	Kirjeldus
`<id>`	Töövoo ID (nõutav)
`--data=<json>`	Valikuline JSON tüüpi koormusobjekt
`--signal=<name>`	Alistab sisendsignaali nime (vaikimisi: `input`)

`wp queuety workflow artifacts`

Loetleb töövoo salvestatud artefaktid.

Shell

wp queuety workflow artifacts <id> [--format=<format>] [--with-content]

Suvand	Kirjeldus
`<id>`	Töövoo ID (nõutav)
`--format=<format>`	Väljundvorming: `table` (vaikimisi) või `json`
`--with-content`	Lisab väljundisse artefakti sisu

`wp queuety workflow artifact`

Kuvab töövoo ühe salvestatud artefakti.

Shell

wp queuety workflow artifact <id> <key>

Suvand	Kirjeldus
`<id>`	Töövoo ID (nõutav)
`<key>`	Artefakti võti (nõutav)

`wp queuety workflow pause`

Peatab töötava töövoo.

Shell

wp queuety workflow pause <id>

Suvand	Kirjeldus
`<id>`	Töövoo ID (nõutav)

`wp queuety workflow resume`

Jätkake peatatud töövoogu.

Shell

wp queuety workflow resume <id>

Suvand	Kirjeldus
`<id>`	Töövoo ID (nõutav)

`wp queuety workflow cancel`

Tühistab töövoo, mis pole juba olekus completed või cancelled. Ühe tehingu käigus seab Queuety olekuks cancelled, matab töövoo ootel ja töötlemisel olevad tööd ning logib väärtuse workflow_cancelled; seejärel käivitab kompensatsioonitoimingud ja registreeritud puhastuskäitleja.

Shell

wp queuety workflow cancel <id>

Suvand	Kirjeldus
`<id>`	Tühistatava töövoo ID (nõutav)

Shell

wp queuety workflow cancel 42

`wp queuety workflow timeline`

Kuvab töövoo sündmuste ajajoone. Näitab kõiki sammusündmusi (alustatud, lõpetatud, nurjunud) koos ajatemplite, töötlejate ja kestustega.

Shell

wp queuety workflow timeline <id> [--limit=<limit>] [--offset=<offset>] [--format=<format>]

Suvand	Kirjeldus
`<id>`	Töövoo ID (nõutav)
`--limit=<limit>`	Tagastatavate sündmuste maksimaalne arv (vaikimisi: `100`)
`--offset=<offset>`	Vahelejäetavate varasemate sündmuste arv (vaikimisi: `0`)
`--format=<format>`	Väljundvorming: `table` (vaikimisi), `json`, `csv`, `yaml`

Shell

wp queuety workflow timeline 42

Väljundveerud: ID, Step, Event, Handler, Duration_ms, Error, Created_at.

`wp queuety workflow state-at`

Kuvab avaliku töövoo oleku pärast kindla töövoo sammu lõpetamist või jätkamist.

Shell

wp queuety workflow state-at <id> <step>

Suvand	Kirjeldus
`<id>`	Töövoo ID (nõutav)
`<step>`	Sammunumber alates 0-st (nõutav)

Shell

wp queuety workflow state-at 42 0

Salvestatava teabe ja kasutusjuhtude kohta vt jaotist Töövoo sündmuste logi.

`wp queuety workflow rewind`

Viib töövoo tagasi eelmise sammuni ja jätkab sellele järgnevast sammust. Olek taastatakse antud sammu sündmuslogi state_after põhjal ning järgmine samm (<step> + 1) pannakse järjekorda; antud sammu ennast uuesti ei käivitata.

Shell

wp queuety workflow rewind <id> <step>

Suvand	Kirjeldus
`<id>`	Töövoo ID (nõutav)
`<step>`	Samm, milleni tagasi kerida, alates 0-st (nõutav)

Shell

wp queuety workflow rewind 42 1

Üksikasju vt jaotisest Ajas rändamine.

`wp queuety workflow fork`

Hargneb töötavast töövoost selle praeguses olekus sõltumatu koopia. Hargnenud töövoog saab uue ID ja jätkub iseseisvalt.

Shell

wp queuety workflow fork <id>

Suvand	Kirjeldus
`<id>`	Hargnemise lähteks oleva töövoo ID (nõutav)

Shell

wp queuety workflow fork 42
# Success: Workflow #42 forked. New workflow ID: 43.

Üksikasju vt jaotisest Hargnemine.

`wp queuety workflow export`

Ekspordib töövoo täieliku täitmisajaloo asukohta JSON. Sisaldab töövoo rida, töid, töövoo sündmusi, logikirjeid, salvestatud signaale ja töövoo sõltuvuste ooteid.

Shell

wp queuety workflow export <id> [--output=<file>]

Suvand	Kirjeldus
`<id>`	Töövoo ID (nõutav)
`--output=<file>`	Failitee, kuhu kirjutada väärtus JSON. Vaikimisi standardväljundisse.

Shell

# Print to stdout
wp queuety workflow export 42

# Write to a file
wp queuety workflow export 42 --output=/tmp/workflow-42.json

Üksikasju struktuuri JSON kohta vt jaotisest Eksport ja taasesitus.

`wp queuety workflow replay`

Taasesitab eksporditud töövoo failist JSON. Loob uue töövoo koos eksporditud oleku, metaandmete ja ajaloolise ajajoonega.

Shell

wp queuety workflow replay <file>

Suvand	Kirjeldus
`<file>`	Eksporditud JSON faili tee (nõutav)

Shell

wp queuety workflow replay /tmp/workflow-42.json
# Success: Workflow replayed. New workflow ID: 85.

Üksikasju vaadake jaotisest Eksportimine ja taasesitus.

Ajakava käsud

`wp queuety schedule list`

Loetleb kõik korduvad ajakavad.

Shell

wp queuety schedule list [--format=<format>]

Suvand	Kirjeldus
`--format=<format>`	Väljundvorming: `table` (vaikimisi), `json`, `csv`, `yaml`

`wp queuety schedule add`

Lisab korduva ajakava.

Shell

wp queuety schedule add <handler> [--every=<interval>] [--cron=<expression>] [--payload=<json>] [--queue=<queue>]

Suvand	Kirjeldus
`<handler>`	Töötleja nimi või klass (nõutav)
`--every=<interval>`	Intervalli avaldis (e.g. `1 hour`, `30 minutes`)
`--cron=<expression>`	Cron avaldis (e.g. `0 3 * * *`)
`--payload=<json>`	JSON koormus (vaikimisi: `{}`)
`--queue=<queue>`	Järjekorra nimi (vaikimisi: `default`)

Määrata tuleb kas --every või --cron.

Shell

wp queuety schedule add cleanup_handler --every="1 hour"
wp queuety schedule add nightly_report --cron="0 3 * * *" --queue=reports

`wp queuety schedule remove`

Eemaldab ajakava töötleja nime järgi.

Shell

wp queuety schedule remove <handler>

Suvand	Kirjeldus
`<handler>`	Eemaldatava töötleja nimi (nõutav)

`wp queuety schedule run`

Käivitab ajastaja takti käsitsi. Paneb järjekorda tööd kõigi tähtaegsete ajakavade jaoks.

Shell

wp queuety schedule run

Logikäsud

`wp queuety log`

Pärib logikirjeid.

Shell

wp queuety log [--job=<id>] [--workflow=<id>] [--handler=<name>] [--event=<event>] [--since=<datetime>] [--limit=<n>] [--format=<format>]

Valik	Kirjeldus
`--job=<id>`	Filtreeri töö ID järgi
`--workflow=<id>`	Filtreeri töövoo ID järgi
`--handler=<name>`	Filtreeri käsitleja nime järgi
`--event=<event>`	Filtreeri sündmuse tüübi järgi (`started`, `completed`, `failed`, `buried`, `retried`, `workflow_started`, `workflow_completed`, `workflow_failed`, `workflow_paused`, `workflow_resumed`, `workflow_cancelled`, `workflow_rewound`, `workflow_forked`, `workflow_deadline_exceeded`, `debug`)
`--since=<datetime>`	Kuva kirjed alates sellest kuupäevast ja kellaajast
`--limit=<n>`	Kuvatud kirjete maksimumarv (vaikimisi: `50`)
`--format=<format>`	Väljundvorming: `table` (vaikimisi), `json`, `csv`, `yaml`

Filtrid ei liitu: Queuety rakendab esimest olemasolevat filtrit järgmises järjekorras: --job, --workflow, --handler, --event, --since. --job ja --workflow tagastavad kõik kirjed vanimast alates ning eiravad valikut --limit. --handler ja --event tagastavad kirjed uusimast alates. Filtrita loeb käsk viimase 24 tunni kirjeid; see päring ja --since loetlevad kirjed vanimast alates, nii et --limit jätab ajavahemikku vanimad kirjed.

Shell

# Logs from the last 24 hours (oldest first)
wp queuety log

# Logs for a job
wp queuety log --job=42

# Failed events
wp queuety log --event=failed --limit=100

# Logs since a specific time
wp queuety log --since="2025-03-01 00:00:00"

Logide kustutamine

LogCommand määratleb alamkäsu purge (wp queuety log purge --older-than=<days>), kuid WP-CLI registreerib wp queuety log eraldiseisva käsuna, mistõttu alamkäsku ei saa kasutada ja see nurjub veaga "Too many positional arguments: purge" (#11). Kustutage vanad logikirjed hoopis asukohast PHP:

Shell

wp eval 'echo Queuety\Queuety::purge_logs( 30 );'

Veebikonksu käsud

`wp queuety webhook add`

Registreerige sündmuse jaoks veebikonks URL.

Shell

wp queuety webhook add <event> <url>

Valik	Kirjeldus
`<event>`	Sündmuse nimi: `job.completed`, `job.failed`, `job.buried` või `workflow.failed` (nõutav)
`<url>`	URL, kuhu teavitused POST-päringuga saata (nõutav)

Shell

wp queuety webhook add job.buried https://hooks.slack.com/services/...

`wp queuety webhook list`

Loetlege kõik registreeritud veebikonksud.

Shell

wp queuety webhook list [--format=<format>]

Suvand	Kirjeldus
`--format=<format>`	Väljundvorming: `table` (vaikimisi), `json`, `csv`, `yaml`

`wp queuety webhook remove`

Eemaldage veebikonks ID järgi.

Shell

wp queuety webhook remove <id>

Valik	Kirjeldus
`<id>`	Eemaldatava veebikonksu ID (nõutav)