Referência de steps

Gerado a partir dos atributos [Step("...")] encontrados em tempo de build — nunca escrito à mão. Regenere com dotnet run --project tools/docs-reference-generator depois de um dotnet build pipevine.slnx -c Release.

Cobre só os steps registrados como IStepFactory — não os seis de controle de fluxo (branch, switch, foreach, parallel, try, group), que o PipelineBuilder trata como sintaxe estrutural do próprio motor, não como um [Step] do registro. Ver Configuração YAML, seção "Controle de fluxo".

type:	Classe	Pacote	Descrição
cache.get	Pipevine.Caching.Abstractions.Steps.GetStepFactory	Pipevine.Caching.Abstractions	cache.get: reads a key and publishes it at steps..result — null on a miss — including a miss produced by fail-open behavior when the cache backend is unavailable.
cache.invalidate	Pipevine.Caching.Abstractions.Steps.InvalidateStepFactory	Pipevine.Caching.Abstractions	cache.invalidate: removes by key (a JSONata expression) or by tag (a literal string) — exactly one of the two.
cache.set	Pipevine.Caching.Abstractions.Steps.SetStepFactory	Pipevine.Caching.Abstractions	cache.set: writes a key with the given TTL(s) and tags. ttl is the absolute expiration, slidingTtl resets on every hit — both optional, see Pipevine.Caching.Abstractions.CacheEntryOptions.
db.delete	Pipevine.Data.Abstractions.Steps.DeleteStepFactory	Pipevine.Data.Abstractions	db.delete: removes the row matched by the entity's declared key.
db.exists	Pipevine.Data.Abstractions.Steps.ExistsStepFactory	Pipevine.Data.Abstractions	db.exists: whether a row matching where exists. Publishes a boolean at steps..result.
db.find	Pipevine.Data.Abstractions.Steps.FindStepFactory	Pipevine.Data.Abstractions	db.find: the entity matched by where, or null. Publishes at steps..result.
db.persist	Pipevine.Data.Abstractions.Steps.PersistStepFactory	Pipevine.Data.Abstractions	db.persist: inserts (or upserts, when onConflict is declared) the object produced by data into the entity's store.
db.query	Pipevine.Data.Abstractions.Steps.QueryStepFactory	Pipevine.Data.Abstractions	db.query: a list matching where, with optional sort (a list of field names, prefixed with - for descending) and skip/take (JSONata expressions, so paging can come from the request itself). Publishes at steps..result.
db.sql	Pipevine.Data.Abstractions.Steps.SqlStepFactory	Pipevine.Data.Abstractions	db.sql: the escape hatch, for queries the structured db.* steps can't express. params' values are JSONata expressions, compiled at build time and evaluated per request — bound as ADO.NET parameters by the provider, never interpolated into the SQL text. That is what makes a value like '; DROP TABLE orders; -- ordinary data instead of an injection: the SQL string itself is fixed at build time and never touches the evaluated values.
db.update	Pipevine.Data.Abstractions.Steps.UpdateStepFactory	Pipevine.Data.Abstractions	db.update: a partial update, matching by the entity's declared key.
fail	Pipevine.Core.Steps.FailStepFactory	Pipevine.Core	fail: stops the pipeline with a structured error.
grpc.call	Pipevine.Integrations.Grpc.Steps.GrpcCallStepFactory	Pipevine.Integrations.Grpc	grpc.call: calls the integration: declared in spec.integrations (kind grpc). Same shape and same fallback contract as http.call (Pipevine.Integrations.Http.Steps.HttpCallStep) — a non-OK status that survives the integration's resilience pipeline runs resilience.fallback when declared.
http.call	Pipevine.Integrations.Http.Steps.HttpCallStepFactory	Pipevine.Integrations.Http	http.call: calls the integration: declared in spec.integrations. Response status >= 500 that survives the integration's own resilience pipeline (or an Pipevine.Integrations.Abstractions.IntegrationCallException the pipeline gave up with) runs the integration's resilience.fallback when one is declared — expression or sub-pipeline — instead of failing the step outright. 4xx is always a business-error Pipevine.Abstractions.StepOutcome.Fail(Pipevine.Abstractions.StepFailure), never retried, never falling back — it means the request itself was rejected, not that the integration is unhealthy.
log	Pipevine.Core.Steps.LogStepFactory	Pipevine.Core	log: a structured log line with a literal message and, optionally, literal structured fields. Field values are literals in Fase 2 — expression evaluation (JSONata) arrives in Fase 3.
map	Pipevine.Core.Steps.MapStepFactory	Pipevine.Core	map: assigns a JSONata-computed value to a path under vars.
noop	Pipevine.Core.Steps.NoopStepFactory	Pipevine.Core	noop: does nothing. Useful in tests and as a placeholder.
publish	Pipevine.Messaging.Abstractions.Steps.PublishStepFactory	Pipevine.Messaging.Abstractions	publish: publishes the event named by event: (an entry of spec.events), with a payload produced by the payload: JSONata expression. mode: direct publishes to the broker synchronously, through the event's Pipevine.Messaging.Abstractions.IMessagePublisher. mode: outbox requires transaction: required on the route/consumer and an ambient transaction that implements Pipevine.Abstractions.Transactions.IOutboxStore — the message is written durably as part of that same transaction, and a background dispatcher (Pipevine.Data.EntityFrameworkCore's outbox) delivers it later, at-least-once.
return	Pipevine.Core.Steps.ReturnStepFactory	Pipevine.Core	return: stops the pipeline successfully, setting output to a literal value.
set	Pipevine.Core.Steps.SetStepFactory	Pipevine.Core	set: assigns a literal value to a path under vars.
validate	Pipevine.Core.Steps.ValidateStepFactory	Pipevine.Core	validate: JSON Schema for shape, JSONata for business rules — never both for the same concern. Both are optional but at least one must be present.