@slates-integrations/dbt-cloud 0.2.0-rc.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +101 -0
- package/dist/index.js +16 -0
- package/dist/index.js.map +1 -0
- package/dist/package.json +3 -0
- package/dist/sourcemap-register.cjs +1 -0
- package/docs/SPEC.md +85 -0
- package/logo.png +0 -0
- package/package.json +25 -0
- package/slate.json +16 -0
package/README.md
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# <img src="https://provider-logos.metorial-cdn.com/dbt-cloud.png" height="20"> Dbt Cloud
|
|
2
|
+
|
|
3
|
+
Manage dbt Cloud account operations for projects, environments, jobs, runs, artifacts, users, and webhook subscriptions. Discover projects and environments, inspect jobs, trigger or retry job runs, monitor run status, cancel queued or running jobs, list and download run artifacts as attachments, audit account users, and create, update, test, or delete webhook subscriptions for job run events.
|
|
4
|
+
|
|
5
|
+
## Tools
|
|
6
|
+
|
|
7
|
+
### Cancel Run
|
|
8
|
+
|
|
9
|
+
Cancel a currently queued or in-progress dbt Cloud job run. The run must be in a cancellable state (Queued, Starting, or Running). Returns the updated run status.
|
|
10
|
+
|
|
11
|
+
### Get Account
|
|
12
|
+
|
|
13
|
+
Retrieve details about the configured dbt Cloud account. Returns account name, plan tier, run slots, developer seat count, and billing information. Useful for verifying the account configuration and available resources.
|
|
14
|
+
|
|
15
|
+
### Get Environment
|
|
16
|
+
|
|
17
|
+
Retrieve details about a specific dbt Cloud environment, including its type, dbt version, credentials, repository, and branch settings.
|
|
18
|
+
|
|
19
|
+
### Get Job
|
|
20
|
+
|
|
21
|
+
Retrieve detailed information about a specific dbt Cloud job, including its schedule, execution steps, settings, and run history metadata. Use this to inspect a job's full configuration before triggering or modifying it.
|
|
22
|
+
|
|
23
|
+
### Get Project
|
|
24
|
+
|
|
25
|
+
Retrieve details about a specific dbt Cloud project, including repository and connection identifiers. Use this after listing projects when you need the full project record or related resources.
|
|
26
|
+
|
|
27
|
+
### Get Run Artifact
|
|
28
|
+
|
|
29
|
+
Fetch an artifact file from a completed dbt Cloud run as a Slate attachment. Supports retrieving `manifest.json`, `run_results.json`, and `catalog.json`.
|
|
30
|
+
|
|
31
|
+
### Get Run
|
|
32
|
+
|
|
33
|
+
Retrieve detailed information about a specific dbt Cloud job run. Returns status, timing, duration, git info, run steps, and execution details. Use this to monitor a triggered run or inspect a completed run's results.
|
|
34
|
+
|
|
35
|
+
### Get Run Failure Details
|
|
36
|
+
|
|
37
|
+
Retrieve retry-related failure details for a failed dbt Cloud run, including the failed step and skipped steps when available.
|
|
38
|
+
|
|
39
|
+
### Get Webhook
|
|
40
|
+
|
|
41
|
+
Retrieve a dbt Cloud webhook subscription by ID, including subscribed events, target URL, active state, and scoped job IDs when available.
|
|
42
|
+
|
|
43
|
+
### List Environments
|
|
44
|
+
|
|
45
|
+
List all environments for a given dbt Cloud project. Returns environment names, types, dbt versions, and configuration details. Useful for inspecting available deployment targets and their settings.
|
|
46
|
+
|
|
47
|
+
### List Jobs
|
|
48
|
+
|
|
49
|
+
List dbt Cloud jobs, optionally filtered by project or environment. Returns job names, schedules, settings, and execution configuration. Use this to discover available jobs that can be triggered or monitored.
|
|
50
|
+
|
|
51
|
+
### List Projects
|
|
52
|
+
|
|
53
|
+
List all projects in the dbt Cloud account. Returns project names, IDs, repository info, and connection details. Use this to discover available projects before performing operations on specific ones.
|
|
54
|
+
|
|
55
|
+
### List Run Artifacts
|
|
56
|
+
|
|
57
|
+
List artifact file paths generated for a completed dbt Cloud run. Use this before fetching a specific artifact such as manifest.json, run_results.json, catalog.json, or sources.json.
|
|
58
|
+
|
|
59
|
+
### List Runs
|
|
60
|
+
|
|
61
|
+
List dbt Cloud job runs with optional filters for job, project, environment, or status. Returns run IDs, statuses, timing, and duration. Useful for monitoring recent execution history and identifying failed or long-running jobs.
|
|
62
|
+
|
|
63
|
+
### List Users
|
|
64
|
+
|
|
65
|
+
List all users in the dbt Cloud account. Returns user names, email addresses, and license information. Useful for auditing account membership and permissions.
|
|
66
|
+
|
|
67
|
+
### List Webhook Events
|
|
68
|
+
|
|
69
|
+
List delivery events for a dbt Cloud webhook subscription. Use this to inspect recent webhook deliveries and troubleshoot downstream receipt behavior.
|
|
70
|
+
|
|
71
|
+
### List Webhooks
|
|
72
|
+
|
|
73
|
+
List dbt Cloud webhook subscriptions configured for the account. Use this to discover webhook IDs before retrieving, updating, testing, or deleting a subscription.
|
|
74
|
+
|
|
75
|
+
### Manage Webhook
|
|
76
|
+
|
|
77
|
+
Create, update, or delete a dbt Cloud webhook subscription. Webhooks notify external systems when job runs start, complete, or fail. Supports scoping to specific jobs and configuring which event types to listen for.
|
|
78
|
+
|
|
79
|
+
### Retry Failed Job
|
|
80
|
+
|
|
81
|
+
Retry the latest failed run for a dbt Cloud job from the point of failure when possible. If dbt Cloud cannot retry from failure, it enqueues a normal job run.
|
|
82
|
+
|
|
83
|
+
### Retry Run
|
|
84
|
+
|
|
85
|
+
Retry a failed dbt Cloud run. dbt Cloud enqueues a new run and returns its run ID and status so it can be monitored with Get Run.
|
|
86
|
+
|
|
87
|
+
### Test Webhook
|
|
88
|
+
|
|
89
|
+
Send a dbt Cloud test event to a webhook subscription endpoint and return the test delivery result.
|
|
90
|
+
|
|
91
|
+
### Trigger Job Run
|
|
92
|
+
|
|
93
|
+
Trigger a new run for a dbt Cloud job. Supports overriding dbt version, threads, target name, timeout, doc generation, and execution steps. If the job is already running, the new run will be enqueued. Returns the created run's details including its ID for monitoring.
|
|
94
|
+
|
|
95
|
+
## License
|
|
96
|
+
|
|
97
|
+
This integration is licensed under the [FSL-1.1](https://github.com/metorial/metorial-platform/blob/dev/LICENSE).
|
|
98
|
+
|
|
99
|
+
<div align="center">
|
|
100
|
+
<sub>Built with ❤️ by <a href="https://metorial.com">Metorial</a></sub>
|
|
101
|
+
</div>
|