deploy_dq_rule_template

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 deploy_dq_rule_template implements the deploy_dq_rule_template MCP tool: it instantiates a rule template as concrete rules across one or more job/column targets, using dialect-specific SQL resolved by the DQ service.

Index ¶

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

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 {
	RuleTemplateName string   `json:"ruleTemplateName" jsonschema:"Required. Name of the rule template to deploy (from list_data_quality_rule_templates)."`
	Targets          []Target `` /* 140-byte string literal not displayed */
	Confirm          bool     `` /* 304-byte string literal not displayed */
}

Input is the tool's typed input.

type Outcome ¶

type Outcome struct {
	JobName          string `json:"jobName" jsonschema:"The target job."`
	ColumnName       string `json:"columnName,omitempty" jsonschema:"The target column, when set."`
	DeployedRuleName string `json:"deployedRuleName,omitempty" jsonschema:"Name of the rule the server created for this target, when deployed."`
	Status           string `json:"status" jsonschema:"Per-target status reported by the DQ service (e.g. deployed or SKIPPED)."`
	Reason           string `json:"reason,omitempty" jsonschema:"Why a target was skipped or failed, when applicable."`
}

Outcome is the per-target result of a deploy.

type Output ¶

type Output struct {
	Status   OutputStatus `` /* 287-byte string literal not displayed */
	Message  string       `json:"message" jsonschema:"Human-readable summary, including deployed vs skipped counts."`
	Preview  *Preview     `` /* 127-byte string literal not displayed */
	Outcomes []Outcome    `` /* 139-byte string literal not displayed */
	Deployed int          `json:"deployed,omitempty" jsonschema:"Number of targets successfully deployed."`
	Skipped  int          `json:"skipped,omitempty" jsonschema:"Number of targets skipped or failed."`
}

Output is the typed response.

type OutputStatus ¶

type OutputStatus string

OutputStatus is the overall outcome of a deploy_dq_rule_template call.

const (
	// StatusSuccess means every target was deployed.
	StatusSuccess OutputStatus = "success"
	// StatusPartial means the deploy ran but some targets were skipped/failed
	// while others were deployed.
	StatusPartial OutputStatus = "partial"
	// StatusValidationError means the inputs failed validation before any write.
	StatusValidationError OutputStatus = "validation_error"
	// StatusError means the deployment failed due to a downstream DQ error.
	StatusError OutputStatus = "error"
	// StatusPreview means confirm was not set: the tool returned the template +
	// target list for review and deployed nothing.
	StatusPreview OutputStatus = "preview"
)

type Preview ¶

type Preview struct {
	RuleTemplateName string   `json:"ruleTemplateName"`
	Targets          []Target `json:"targets"`
	Count            int      `json:"count"`
}

Preview is the deployment plan echoed back for review when confirm is false.

type Target ¶

type Target struct {
	JobName    string `` /* 196-byte string literal not displayed */
	ColumnName string `` /* 171-byte string literal not displayed */
}

Target is one deployment target.

Source Files ¶

View all Source files

tool.go

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