gxsql

package module

Go to main page

Versions in this module

v0

v0.2.0

Jul 28, 2026

Changes in this version

+ type CountQuery struct

+ func TrustedCountQuery(template string, args ...any) CountQuery

type Expectation

+ func CustomCount(name string, query CountQuery) Expectation

+ func WithMaxFailedCount(max int, exp Expectation) Expectation

type ExportedFacts

+ ConfiguredMaxFailedCount *int

type ExportedResult

+ Tolerated bool

type Option

+ func WithScope(scope Scope) Option

type Report

+ ScopeID string

type Result

+ Tolerated bool

type ResultFacts

+ ConfiguredMaxFailedCount *int

+ type Scope struct

+ func TrustedScope(id, predicate string, args ...any) Scope

v0.1.0

Jul 20, 2026

Changes in this version

+ const DefaultFailedKeysCap

+ const DefaultSampleCap

+ const ExportSchemaVersion

+ const MaxExportedArgumentCount

+ const MaxExportedErrorMessageRunes

+ const MaxExportedQueryTextRunes

+ var ErrCategoryContext = &categoryMarker

+ var ErrCategoryDatabase = &categoryMarker

+ var ErrCategoryInvalidConfig = &categoryMarker

+ var ErrCategoryObserver = &categoryMarker

+ var ErrCategoryRendering = &categoryMarker

+ var ErrCategoryScan = &categoryMarker

+ var ErrCategoryUnsupported = &categoryMarker

+ type CategorizedError struct

+ Category ErrorCategory

+ Err error

+ func (e *CategorizedError) Error() string

+ func (e *CategorizedError) Is(target error) bool

+ func (e *CategorizedError) Unwrap() error

+ type ColumnBuilder struct

+ func Column(name string) ColumnBuilder

+ func (c ColumnBuilder) DistinctCount() DistinctCountBuilder

+ func (c ColumnBuilder) In(vals ...any) Expectation

+ func (c ColumnBuilder) IsNull() Expectation

+ func (c ColumnBuilder) NotIn(vals ...any) Expectation

+ func (c ColumnBuilder) NotNull() Expectation

+ func (c ColumnBuilder) Unique() Expectation

+ type DB interface

+ QueryContext func(ctx context.Context, query string, args ...any) (*sql.Rows, error)

+ QueryRowContext func(ctx context.Context, query string, args ...any) *sql.Row

+ type Dialect interface

+ Placeholder func(n int) string

+ QuoteIdent func(name string) (string, error)

+ StringLength func(expr string) string

+ func DuckDB() Dialect

+ func MySQL() Dialect

+ func Postgres() Dialect

+ func SQLite() Dialect

+ type DistinctCountBuilder struct

+ func (b DistinctCountBuilder) Between(lo, hi int) Expectation

+ func (b DistinctCountBuilder) Equal(want int) Expectation

+ func (b DistinctCountBuilder) GreaterOrEqual(bound int) Expectation

+ func (b DistinctCountBuilder) GreaterThan(bound int) Expectation

+ func (b DistinctCountBuilder) LessOrEqual(bound int) Expectation

+ func (b DistinctCountBuilder) LessThan(bound int) Expectation

+ type ErrorCategory string

+ const CategoryContext

+ const CategoryDatabase

+ const CategoryInvalidConfig

+ const CategoryObserver

+ const CategoryRendering

+ const CategoryScan

+ const CategoryUnsupported

+ type ExecutionOutcome string

+ const ExecutionOutcomeConfigFailure

+ const ExecutionOutcomeExecutionFailure

+ const ExecutionOutcomeOK

+ const ExecutionOutcomePolicyFailure

+ type Expectation interface

+ Name func() string

+ func WithID(id string, exp Expectation) Expectation

+ type ExpectationKind string

+ const KindAverageBetween

+ const KindBetween

+ const KindCustom

+ const KindDistinctCountBetween

+ const KindDistinctCountEqual

+ const KindDistinctCountGreaterEqual

+ const KindDistinctCountGreaterThan

+ const KindDistinctCountLessEqual

+ const KindDistinctCountLessThan

+ const KindEmpty

+ const KindGreaterOrEqual

+ const KindGreaterThan

+ const KindIn

+ const KindIsNull

+ const KindLenBetween

+ const KindLenEqual

+ const KindLessOrEqual

+ const KindLessThan

+ const KindMaxLessOrEqual

+ const KindMinGreaterOrEqual

+ const KindNotEmpty

+ const KindNotIn

+ const KindNotNull

+ const KindRowCountBetween

+ const KindRowCountEqual

+ const KindRowCountGreaterEqual

+ const KindRowCountGreaterThan

+ const KindRowCountLessEqual

+ const KindRowCountLessThan

+ const KindUnique

+ type ExportOption func(*exportConfig)

+ func IncludeCapturedArguments() ExportOption

+ func IncludeCapturedDiagnostics() ExportOption

+ func IncludeFailedKeys() ExportOption

+ func IncludeSamples() ExportOption

+ func WithArgsRedactor(fn Redactor) ExportOption

+ func WithKeyRedactor(fn Redactor) ExportOption

+ func WithQueryRedactor(fn Redactor) ExportOption

+ func WithSampleRedactor(fn Redactor) ExportOption

+ type ExportedCaps struct

+ KeysReturned int

+ KeysTruncated bool

+ SamplesReturned int

+ SamplesTruncated bool

+ type ExportedCounts struct

+ Failed *int

+ FailedPercent *float64

+ Total *int

+ type ExportedDiagnostics struct

+ Args []NormalizedValue

+ ArgsTruncated bool

+ Query string

+ QueryTruncated bool

+ type ExportedError struct

+ Category ErrorCategory

+ Message string

+ type ExportedFacts struct

+ ConfiguredBound *NormalizedValue

+ ConfiguredBoundLower *NormalizedValue

+ ConfiguredBoundUpper *NormalizedValue

+ ConfiguredCount *int

+ ConfiguredCountLower *int

+ ConfiguredCountUpper *int

+ ConfiguredFloatBound *NormalizedValue

+ ConfiguredFloatLower *NormalizedValue

+ ConfiguredFloatUpper *NormalizedValue

+ ObservedCount *int

+ ObservedFloat *NormalizedValue

+ type ExportedReport struct

+ Results []ExportedResult

+ SchemaVersion string

+ Scope *ExportedScope

+ Target *ExportedTarget

+ func ExportReport(report Report, opts ...ExportOption) (ExportedReport, error)

+ type ExportedResult struct

+ Caps *ExportedCaps

+ Column string

+ Counts *ExportedCounts

+ Diagnostics *ExportedDiagnostics

+ DisplayName string

+ Errors []ExportedError

+ ExecutionOutcome ExecutionOutcome

+ Facts *ExportedFacts

+ FailedKeys []NormalizedValue

+ ID string

+ Kind ExpectationKind

+ PolicyVerdict PolicyVerdict

+ RowDenominator RowDenominator

+ Samples []NormalizedValue

+ type ExportedScope struct

+ ID string

+ type ExportedTarget struct

+ Schema string

+ Table string

+ type NormalizedValue struct

+ Exact bool

+ Kind string

+ Value any

+ type NumberColumn struct

+ func Float(name string) NumberColumn

+ func Int(name string) NumberColumn

+ func (c NumberColumn) AverageBetween(lo, hi float64) Expectation

+ func (c NumberColumn) Between(lo, hi any) Expectation

+ func (c NumberColumn) GreaterOrEqual(bound any) Expectation

+ func (c NumberColumn) GreaterThan(bound any) Expectation

+ func (c NumberColumn) LessOrEqual(bound any) Expectation

+ func (c NumberColumn) LessThan(bound any) Expectation

+ func (c NumberColumn) MaxLessOrEqual(bound float64) Expectation

+ func (c NumberColumn) MinGreaterOrEqual(bound float64) Expectation

+ type Option func(*validateConfig)

+ func CaptureQueryDiagnostics() Option

+ func ContinueOnError() Option

+ func SummaryOnly() Option

+ func WithDialect(d Dialect) Option

+ func WithFailedKeysCap(n int) Option

+ func WithKey(columns ...string) Option

+ func WithSampleCap(n int) Option

+ type PolicyVerdict string

+ const PolicyVerdictFail

+ const PolicyVerdictPass

+ const PolicyVerdictUnevaluated

+ type PreflightErrors struct

+ Issues []PreflightIssue

+ func (e *PreflightErrors) Error() string

+ func (e *PreflightErrors) Unwrap() []error

+ type PreflightIssue struct

+ Err error

+ ID string

+ Index int

+ type Redactor func(any) (any, error)

+ type Report struct

+ Results []Result

+ Target *TableRef

+ func (r Report) Err() error

+ func (r Report) Failures() []Result

+ func (r Report) OK() bool

+ func (r Report) String() string

+ type Result struct

+ Column string

+ Err error

+ Facts ResultFacts

+ FailedCount int

+ FailedKeys []RowKey

+ FailedPercent float64

+ ID string

+ Kind ExpectationKind

+ Name string

+ RowDenominator RowDenominator

+ SampleValues []any

+ Success bool

+ Total int

+ func (r Result) String() string

+ type ResultFacts struct

+ ConfiguredBound any

+ ConfiguredBoundLower any

+ ConfiguredBoundUpper any

+ ConfiguredCount *int

+ ConfiguredCountLower *int

+ ConfiguredCountUpper *int

+ ConfiguredFloatBound *float64

+ ConfiguredFloatLower *float64

+ ConfiguredFloatUpper *float64

+ ObservedCount *int

+ ObservedFloat *float64

+ type RowCountBuilder struct

+ func RowCount() RowCountBuilder

+ func (RowCountBuilder) Between(lo, hi int) Expectation

+ func (RowCountBuilder) Equal(want int) Expectation

+ func (RowCountBuilder) GreaterOrEqual(bound int) Expectation

+ func (RowCountBuilder) GreaterThan(bound int) Expectation

+ func (RowCountBuilder) LessOrEqual(bound int) Expectation

+ func (RowCountBuilder) LessThan(bound int) Expectation

+ type RowDenominator string

+ const RowDenominatorAvailable

+ const RowDenominatorUnavailable

+ type RowKey []any

+ type StringColumn struct

+ func String(name string) StringColumn

+ func (c StringColumn) Empty() Expectation

+ func (c StringColumn) LenBetween(lo, hi int) Expectation

+ func (c StringColumn) LenEqual(n int) Expectation

+ func (c StringColumn) NotEmpty() Expectation

+ type Suite struct

+ func NewSuite(exps ...Expectation) *Suite

+ func (s *Suite) ValidateTable(ctx context.Context, db DB, table TableRef, opts ...Option) (Report, error)

+ func (s *Suite) WithFailedKeysCap(n int) *Suite

+ func (s *Suite) WithSampleCap(n int) *Suite

+ type TableRef struct

+ Name string

+ Schema string

+ func SchemaTable(schema, name string) TableRef

+ func Table(name string) TableRef

+ type ValidationError struct

+ Report Report

+ func (e *ValidationError) Error() string

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