get_dq_job

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_job implements the dq_get_job MCP tool — read the full definition of a single Collibra data-quality job by name.

The flow converges on the public single-job GET, with a fallback for a partial/fuzzy name:

Exact  : GET /rest/dq/1.0/jobs/{jobName} -> on success, return the job definition.
Fuzzy  : on a 404, GET /rest/dq/1.0/jobs?jobName=<name> (searchJobs, %LIKE% match) -> zero
         matches: not-found error; exactly one: fetch and return it; several: return the
         candidate names (needs_input) so the caller can pick one and re-call with the exact name.

This is a pure read: no confirm checkpoint, no writes. 400/401/403/404/500 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 JobDetail
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]

NewTool returns the registered tool.

Types ¶

type Input ¶

type Input struct {
	Name string `` /* 294-byte string literal not displayed */
}

Input is the tool's typed input.

type JobDetail ¶

type JobDetail struct {
	JobName        string `json:"jobName"`
	JobType        string `json:"jobType,omitempty" jsonschema:"The job's execution type: PUSHDOWN or PULLUP."`
	EdgeSiteName   string `json:"edgeSiteName,omitempty"`
	ConnectionName string `json:"connectionName,omitempty" jsonschema:"The edge connection the job reads through."`
	DataSourceName string `json:"dataSourceName,omitempty" jsonschema:"The database/catalog the job reads from."`
	SchemaName     string `json:"schemaName,omitempty"`
	TableName      string `json:"tableName,omitempty"`
	SourceQuery    string `json:"sourceQuery,omitempty" jsonschema:"The SQL the job runs against the source."`
	RunDate        string `json:"runDate,omitempty" jsonschema:"Start of the job's configured run-date window, if any."`
	RunDateEnd     string `json:"runDateEnd,omitempty" jsonschema:"Exclusive end of the run-date window, if any."`

	AdaptiveMonitors []string `json:"adaptiveMonitors,omitempty" jsonschema:"Enabled built-in adaptive monitor keys (e.g. rowCount, nullValues)."`
	CustomMonitors   []string `` /* 164-byte string literal not displayed */
	NotificationsSet bool     `json:"notificationsSet,omitempty" jsonschema:"Whether the job has any notification configuration."`
	ScheduleEnabled  bool     `json:"scheduleEnabled,omitempty" jsonschema:"Whether the job currently has an active schedule."`
	ScheduleMode     string   `json:"scheduleMode,omitempty" jsonschema:"The schedule's mode (HOURLY/DAILY/MONTHLY), when scheduled."`
	JobDetailsLink   string   `json:"jobDetailsLink,omitempty" jsonschema:"Job Details deep-link path (relative to the Collibra instance URL)."`
}

JobDetail is the full job definition returned on success.

type Output ¶

type Output struct {
	Status            Status     `` /* 154-byte string literal not displayed */
	Message           string     `json:"message" jsonschema:"Human-readable summary."`
	Job               *JobDetail `json:"job,omitempty" jsonschema:"The job definition, on success."`
	CandidateJobNames []string   `` /* 135-byte string literal not displayed */
	Guidance          string     `json:"guidance,omitempty" jsonschema:"On needs_input/error, what to do next."`
}

Output is the typed response.

type Status ¶

type Status string

const (
	StatusSuccess    Status = "success"
	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