delete_dq_job

package

v0.0.56 Latest Latest Go to latest Published: Sep 7, 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 delete_dq_job implements the dq_delete_job MCP tool — permanently delete a Collibra data-quality job definition, along with every run, rule and result attached to it.

The flow is a two-call converge on the public delete:

Look up : GET    /rest/dq/1.0/jobs/{jobName} -> on failure, relay a meaningful error;
          on success, summarise the job (confirm_required) so the user can review it.
Delete  : DELETE /rest/dq/1.0/jobs/{jobName} — only once the caller re-calls with confirm=true.

Deletion is irreversible, so — as in dq_delete_job_run — confirm=false (the default) is strictly READ-ONLY: it never reaches the DELETE. Permissions are enforced by the server; 400/401/403/404/409 and transport failures are surfaced as messages with actionable guidance rather than Go errors.

Index ¶

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewTool ¶

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

Types ¶

type Input ¶

type Input struct {
	JobName string `json:"jobName" jsonschema:"The name of the data-quality job to delete."`
	Confirm bool   `` /* 211-byte string literal not displayed */
}

type JobSummary ¶

type JobSummary struct {
	JobName         string `json:"jobName" jsonschema:"Re-call the tool with this jobName and confirm=true to delete this job."`
	JobType         string `json:"jobType,omitempty" jsonschema:"The job's execution type (PUSHDOWN/PULLUP), if known."`
	EdgeSiteName    string `json:"edgeSiteName,omitempty" jsonschema:"The edge site the job runs on."`
	ConnectionName  string `json:"connectionName,omitempty" jsonschema:"The edge connection the job reads through."`
	SchemaName      string `json:"schemaName,omitempty" jsonschema:"The schema the job reads from."`
	TableName       string `json:"tableName,omitempty" jsonschema:"The table the job reads from."`
	SourceQuery     string `json:"sourceQuery,omitempty" jsonschema:"The SQL the job runs against the source."`
	ScheduleEnabled bool   `` /* 137-byte string literal not displayed */
	ScheduleMode    string `json:"scheduleMode,omitempty" jsonschema:"The schedule's mode (HOURLY/DAILY/MONTHLY/...), when scheduled."`
	RunDate         string `json:"runDate,omitempty" jsonschema:"The job's configured run date, if any."`
}

JobSummary describes the job that is about to be deleted, so the user can check it is the right one.

type Output ¶

type Output struct {
	Status         Status      `json:"status" jsonschema:"deleted | confirm_required | needs_input | error."`
	Message        string      `json:"message" jsonschema:"Human-readable outcome and what to do next."`
	JobName        string      `json:"jobName,omitempty" jsonschema:"The job that was deleted (or, on confirm_required, the one to confirm)."`
	Job            *JobSummary `` /* 135-byte string literal not displayed */
	JobDetailsLink string      `json:"jobDetailsLink,omitempty" jsonschema:"Job Details deep-link path (relative to the Collibra instance URL)."`
	Guidance       string      `json:"guidance,omitempty" jsonschema:"On confirm_required/needs_input/error, what to do next."`
}

type Status ¶

type Status string

const (
	StatusDeleted         Status = "deleted"
	StatusConfirmRequired Status = "confirm_required"
	StatusNeedsInput      Status = "needs_input"
	StatusError           Status = "error"
)

Source Files ¶

View all Source files

tool.go

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