get_dq_rule

package

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

Details

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

Repository

github.com/collibra/chip

Links

Open Source Insights

Documentation ¶

Overview ¶

Package get_dq_rule implements the get_dq_rule MCP tool: it reads the definition of a single data quality rule (monitor) on an existing DQ job.

Index ¶

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

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 {
	JobName     string `` /* 194-byte string literal not displayed */
	MonitorName string `json:"monitorName" jsonschema:"Required. Name of the rule (the check; Collibra calls it a 'monitor') to read."`
}

Input is the tool's typed input.

type Output ¶

type Output struct {
	Status  OutputStatus `` /* 132-byte string literal not displayed */
	Message string       `json:"message" jsonschema:"Human-readable summary."`
	Rule    *Rule        `json:"rule,omitempty" jsonschema:"The rule definition, on success."`
}

Output is the typed response.

type OutputStatus ¶

type OutputStatus string

OutputStatus is the overall outcome of a get_dq_rule call.

const (
	// StatusSuccess means the rule was found and returned.
	StatusSuccess OutputStatus = "success"
	// StatusValidationError means the inputs failed validation before any read.
	StatusValidationError OutputStatus = "validation_error"
	// StatusError means the rule could not be read due to a downstream DQ error.
	StatusError OutputStatus = "error"
)

type Rule ¶

type Rule struct {
	JobName      string   `json:"jobName"`
	MonitorName  string   `json:"monitorName"`
	MonitorType  string   `json:"monitorType"`
	MonitorValue string   `json:"monitorValue"`
	FilterQuery  string   `json:"filterQuery,omitempty"`
	ColumnName   string   `json:"columnName,omitempty"`
	Description  string   `json:"description,omitempty"`
	Dimensions   []string `json:"dimensions,omitempty"`
	Tolerance    int      `json:"tolerance"`
	Active       bool     `json:"active"`
	Suppressed   bool     `json:"suppressed"`
	TemplateID   string   `json:"templateId,omitempty"`
}

Rule is the returned rule definition.

Source Files ¶

View all Source files

tool.go

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