capabilities

package

v0.3.3 Latest Latest Go to latest Published: Sep 16, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/block/pg-sprite

Links

Open Source Insights

Documentation ¶

Overview ¶

Package capabilities provides the embedded, validated support matrix and its Markdown renderer.

Index ¶

Constants
func RenderDocument(input []byte, rows []Row) ([]byte, error)
func Validate(rows []Row) error
type Area
type EnginePath
type FrontDoorStatus
type FrontDoors
type Row
- func Load(data []byte) ([]Row, error)
- func Rows() ([]Row, error)
type StatusMark
type Tier

Constants ¶

View Source

const (
	AreaColumnChanges               Area            = "column_changes"
	AreaConstraints                 Area            = "constraints"
	AreaIndexes                     Area            = "indexes"
	AreaPartitionedTables           Area            = "partitioned_tables"
	AreaDeclarativeModel            Area            = "declarative_model"
	AreaTypesAndNonTableObjects     Area            = "types_and_non_table_objects"
	AreaDataAndWholeTableOperations Area            = "data_and_whole_table_operations"
	TierOne                         Tier            = "t1"
	TierTwo                         Tier            = "t2"
	TierThree                       Tier            = "t3"
	StatusSupported                 StatusMark      = "✅"
	StatusPlanned                   StatusMark      = "🟡"
	StatusNoSafetyProblem           StatusMark      = "⚪"
	StatusOtherTool                 StatusMark      = "🔵"
	StatusNoOnlineMechanism         StatusMark      = "❌"
	PathNativeAsIs                  EnginePath      = "native_as_is"
	PathNativeSaferSequence         EnginePath      = "native_safer_sequence"
	PathNativePlannedFlow           EnginePath      = "native_planned_flow"
	PathCopyAndSwap                 EnginePath      = "copy_and_swap"
	PathNone                        EnginePath      = "none"
	DoorSupported                   FrontDoorStatus = "supported"
	DoorRefused                     FrontDoorStatus = "refused"
	DoorNotApplicable               FrontDoorStatus = "not_applicable"
)

Closed values used by capability rows.

Variables ¶

This section is empty.

Functions ¶

func RenderDocument ¶

func RenderDocument(input []byte, rows []Row) ([]byte, error)

RenderDocument replaces every marked generated region in a capabilities document.

func Validate ¶

func Validate(rows []Row) error

Validate checks closed vocabularies and cross-field invariants.

Types ¶

type Area ¶

type Area string

Area identifies one matrix table.

type EnginePath ¶

type EnginePath string

EnginePath identifies how the engine executes or plans to execute an operation.

type FrontDoorStatus ¶

type FrontDoorStatus string

FrontDoorStatus describes admission through one CLI front door.

type FrontDoors ¶

type FrontDoors struct {
	Migrate FrontDoorStatus `yaml:"migrate" json:"migrate"`
	Diff    FrontDoorStatus `yaml:"diff" json:"diff"`
}

FrontDoors records admission through the imperative and declarative interfaces.

type Row ¶

type Row struct {
	ID                  string         `yaml:"id" json:"id"`
	Area                Area           `yaml:"area" json:"area"`
	Operation           string         `yaml:"operation" json:"operation"`
	Tier                Tier           `yaml:"tier" json:"tier"`
	StatusMark          StatusMark     `yaml:"status_mark" json:"status_mark"`
	EnginePath          EnginePath     `yaml:"engine_path" json:"engine_path"`
	OnlineSafetyProblem bool           `yaml:"online_safety_problem" json:"online_safety_problem"`
	OnlineSafetyDetail  string         `yaml:"online_safety_detail,omitempty" json:"online_safety_detail,omitempty"`
	OwningToolClass     string         `yaml:"owning_tool_class,omitempty" json:"owning_tool_class,omitempty"`
	FrontDoors          FrontDoors     `yaml:"front_doors" json:"front_doors"`
	RefusalReason       verdict.Reason `yaml:"refusal_reason,omitempty" json:"refusal_reason,omitempty"`
	ReasonNotes         string         `yaml:"reason_notes" json:"reason_notes"`
}