validate_dq_rule

package
v0.0.48 Latest Latest
Warning

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

Go to latest
Published: Aug 11, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package validate_dq_rule implements the validate_dq_rule MCP tool: it checks that a rule's SQL/definition is valid before it is saved or run, so a bad rule is caught up front rather than at run time.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewTool

func NewTool(collibraClient *http.Client) *chip.Tool[Input, Output]

NewTool returns the registered tool.

Types

type Input

type Input struct {
	EdgeSiteID   string `` /* 171-byte string literal not displayed */
	ConnectionID string `` /* 162-byte string literal not displayed */
	SchemaName   string `json:"schemaName" jsonschema:"Required. Schema name the rule runs against."`
	JobName      string `` /* 160-byte string literal not displayed */
	PreviewRule  string `json:"previewRule" jsonschema:"Required. The rule SQL to validate (the same value you would pass as monitorValue)."`
	FilterQuery  string `json:"filterQuery,omitempty" jsonschema:"Optional. Additional WHERE-clause filter applied to the rule."`
	RowLimit     int    `json:"rowLimit,omitempty" jsonschema:"Optional. Row limit for the underlying probe query. Defaults to 0 (service default)."`
}

Input is the tool's typed input. edgeSiteId/connectionId/schemaName are the discovery fields from prepare_create_dq_job.

type Output

type Output struct {
	Status  OutputStatus `` /* 128-byte string literal not displayed */
	Message string       `json:"message" jsonschema:"Human-readable summary, including the validation message from the DQ engine."`
	Valid   bool         `json:"valid" jsonschema:"True when the rule is valid; false when the DQ engine rejected it (see message)."`
}

Output is the typed response.

type OutputStatus

type OutputStatus string

OutputStatus is the overall outcome of a validate_dq_rule call.

const (
	// StatusSuccess means validation ran (see Valid for the verdict).
	StatusSuccess OutputStatus = "success"
	// StatusValidationError means the inputs failed validation before any call.
	StatusValidationError OutputStatus = "validation_error"
	// StatusError means validation could not run due to a downstream error.
	StatusError OutputStatus = "error"
)

Jump to

Keyboard shortcuts

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