rules

package
v0.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 9, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Overview

Package rules provides consolidation rule management for pgsquash.

Index

Constants

This section is empty.

Variables

View Source
var (
	// GetRegistry returns the global rule registry singleton
	GetRegistry = consolidation.GetRegistry
)

Registry access

Functions

func CategoryDescriptions

func CategoryDescriptions() map[RuleCategory]string

CategoryDescriptions returns descriptions for all categories

func CategoryNames

func CategoryNames() map[RuleCategory]string

CategoryNames returns human-readable names for all categories

Types

type ConflictPolicy

type ConflictPolicy = consolidation.ConflictPolicy

ConflictPolicy determines how rule conflicts are resolved

const (
	// ConflictPolicyHighestPriority uses rule with highest priority (default)
	ConflictPolicyHighestPriority ConflictPolicy = consolidation.ConflictPolicyHighestPriority

	// ConflictPolicyFirstRegistered uses first registered rule
	ConflictPolicyFirstRegistered ConflictPolicy = consolidation.ConflictPolicyFirstRegistered

	// ConflictPolicyError fails on conflicts
	ConflictPolicyError ConflictPolicy = consolidation.ConflictPolicyError
)

Conflict policies

type ConsolidationRule

type ConsolidationRule = tracking.ConsolidationRule

ConsolidationRule is the interface that all consolidation rules implement

type RegisteredRule

type RegisteredRule = consolidation.RegisteredRule

RegisteredRule wraps a ConsolidationRule with metadata

type RegistryStats

type RegistryStats = consolidation.RegistryStats

RegistryStats provides statistics about the registry

type RuleCategory

type RuleCategory = consolidation.RuleCategory

RuleCategory represents the category of a consolidation rule

const (
	// CategoryTableOps includes table CREATE/ALTER consolidation rules
	CategoryTableOps RuleCategory = consolidation.CategoryTableOps

	// CategoryFunctionOps includes function deduplication rules
	CategoryFunctionOps RuleCategory = consolidation.CategoryFunctionOps

	// CategoryDeadCode includes dead code removal rules
	CategoryDeadCode RuleCategory = consolidation.CategoryDeadCode

	// CategorySecurity includes RLS, policies, and auth rules
	CategorySecurity RuleCategory = consolidation.CategorySecurity

	// CategoryOptimization includes performance optimization rules
	CategoryOptimization RuleCategory = consolidation.CategoryOptimization

	// CategoryExtension includes extension-specific rules
	CategoryExtension RuleCategory = consolidation.CategoryExtension

	// CategoryPluginAuth includes plugin authentication pattern rules
	CategoryPluginAuth RuleCategory = consolidation.CategoryPluginAuth

	// CategoryPluginORM includes ORM-specific pattern rules
	CategoryPluginORM RuleCategory = consolidation.CategoryPluginORM
)

Rule categories

type RuleMetadata

type RuleMetadata = consolidation.RuleMetadata

RuleMetadata provides descriptive information about a consolidation rule

type RuleRegistry

type RuleRegistry = consolidation.RuleRegistry

RuleRegistry manages dynamic rule registration with priorities and filtering

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL