Skip to content

Commit 705bfd1

Browse files
smackeseysmackesey
committed
[dg] Remove dg list component-type (#29095)
## Summary & Motivation Remove `dg list component-type`. Convert `dg list component-type` tests to use `dg list plugins` instead. ## How I Tested These Changes Modified existing tests. ## Changelog The `dg list component-type` command has been removed. There is a new `dg list plugins` with output that is a superset of `dg list component-type`.
1 parent bc44a63 commit 705bfd1

File tree

14 files changed

+174
-74
lines changed

14 files changed

+174
-74
lines changed

‎docs/docs/guides/labs/components/components-etl-pipeline-tutorial.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ To learn more about the files, directories, and default settings in a project sc
6464

6565
To ingest data, you must set up [Sling](https://slingdata.io/). However, if you list the available component types in your environment at this point, the Sling component won't appear, since the `dagster` package doesn't contain components for specific integrations (like Sling):
6666

67-
<CliInvocationExample path="docs_snippets/docs_snippets/guides/components/index/7-dg-list-component-types.txt" />
67+
<CliInvocationExample path="docs_snippets/docs_snippets/guides/components/index/7-dg-list-plugins.txt" />
6868

6969
To make the Sling component available in your environment, install the `dagster-sling` package:
7070

@@ -82,7 +82,7 @@ When you run commands like `dg list component-type` , `dg` obtains the results b
8282

8383
To confirm that the `dagster_sling.SlingReplicationCollectionComponent` component type is now available, run the `dg list component-type` command again:
8484

85-
<CliInvocationExample path="docs_snippets/docs_snippets/guides/components/index/8-dg-list-component-types.txt" />
85+
<CliInvocationExample path="docs_snippets/docs_snippets/guides/components/index/8-dg-list-plugins.txt" />
8686

8787
### 3. Create a new instance of the Sling component
8888

@@ -162,7 +162,7 @@ To interface with the dbt project, you will need to instantiate a Dagster dbt pr
162162

163163
To confirm that the `dagster_dbt.DbtProjectComponent` component type is now available, run `dg list component-type`:
164164

165-
<CliInvocationExample path="docs_snippets/docs_snippets/guides/components/index/17-dg-list-component-types.txt" />
165+
<CliInvocationExample path="docs_snippets/docs_snippets/guides/components/index/17-dg-list-plugins.txt" />
166166

167167
### 3. Scaffold a new instance of the dbt project component
168168

‎docs/docs/guides/labs/components/creating-new-component-types/creating-and-registering-a-component-type.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Our `build_defs` method will create a single `@asset` that executes the provided
8989

9090
Following the steps above will automatically register your component type in your environment. You can now run:
9191

92-
<CliInvocationExample path="docs_snippets/docs_snippets/guides/components/shell-script-component/3-dg-list-component-types.txt" />
92+
<CliInvocationExample path="docs_snippets/docs_snippets/guides/components/shell-script-component/3-dg-list-plugins.txt" />
9393

9494
and see your new component type in the list of available component types.
9595

examples/docs_snippets/docs_snippets/guides/components/index/17-dg-list-component-types.txt renamed to examples/docs_snippets/docs_snippets/guides/components/index/17-dg-list-plugins.txt

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
dg list component-type
1+
dg list plugins
22

33
Using /.../jaffle-platform/.venv/bin/dagster-components
44
┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
@@ -7,6 +7,11 @@ Using /.../jaffle-platform/.venv/bin/dagster-components
77
│ dagster │ ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┓ │
88
│ │ ┃ Symbol ┃ Summary ┃ Features ┃ │
99
│ │ ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━┩ │
10+
│ │ │ dagster.asset │ Create a │ [scaffold-targ… │ │
11+
│ │ │ │ definition for │ │ │
12+
│ │ │ │ how to compute │ │ │
13+
│ │ │ │ an asset. │ │ │
14+
│ │ ├─────────────────────────────────────────────────────────────┼──────────────────┼─────────────────┤ │
1015
│ │ │ dagster.components.DefinitionsComponent │ An arbitrary set │ [component, │ │
1116
│ │ │ │ of dagster │ scaffold-targe… │ │
1217
│ │ │ │ definitions. │ │ │
@@ -23,6 +28,23 @@ Using /.../jaffle-platform/.venv/bin/dagster-components
2328
│ │ │ │ executed with │ │ │
2429
│ │ │ │ Dagster's │ │ │
2530
│ │ │ │ PipesSubprocess… │ │ │
31+
│ │ ├─────────────────────────────────────────────────────────────┼──────────────────┼─────────────────┤ │
32+
│ │ │ dagster.schedule │ Creates a │ [scaffold-targ… │ │
33+
│ │ │ │ schedule │ │ │
34+
│ │ │ │ following the │ │ │
35+
│ │ │ │ provided cron │ │ │
36+
│ │ │ │ schedule and │ │ │
37+
│ │ │ │ requests runs │ │ │
38+
│ │ │ │ for the provided │ │ │
39+
│ │ │ │ job. │ │ │
40+
│ │ ├─────────────────────────────────────────────────────────────┼──────────────────┼─────────────────┤ │
41+
│ │ │ dagster.sensor │ Creates a sensor │ [scaffold-targ… │ │
42+
│ │ │ │ where the │ │ │
43+
│ │ │ │ decorated │ │ │
44+
│ │ │ │ function is used │ │ │
45+
│ │ │ │ as the sensor's │ │ │
46+
│ │ │ │ evaluation │ │ │
47+
│ │ │ │ function. │ │ │
2648
│ │ └─────────────────────────────────────────────────────────────┴──────────────────┴─────────────────┘ │
2749
│ dagster_dbt │ ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ │
2850
│ │ ┃ Symbol ┃ Summary ┃ Features ┃ │

examples/docs_snippets/docs_snippets/guides/components/index/7-dg-list-component-types.txt renamed to examples/docs_snippets/docs_snippets/guides/components/index/7-dg-list-plugins.txt

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
1-
dg list component-type
1+
dg list plugins
22

33
┏━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
44
┃ Plugin ┃ Objects ┃
55
┡━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
66
│ dagster │ ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┓ │
77
│ │ ┃ Symbol ┃ Summary ┃ Features ┃ │
88
│ │ ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━┩ │
9+
│ │ │ dagster.asset │ Create a │ [scaffold-target] │ │
10+
│ │ │ │ definition for how │ │ │
11+
│ │ │ │ to compute an │ │ │
12+
│ │ │ │ asset. │ │ │
13+
│ │ ├─────────────────────────────────────────────────────────────┼────────────────────┼─────────────────────┤ │
914
│ │ │ dagster.components.DefinitionsComponent │ An arbitrary set │ [component, │ │
1015
│ │ │ │ of dagster │ scaffold-target] │ │
1116
│ │ │ │ definitions. │ │ │
@@ -21,5 +26,20 @@ dg list component-type
2126
│ │ │ │ executed with │ │ │
2227
│ │ │ │ Dagster's │ │ │
2328
│ │ │ │ PipesSubprocessCl… │ │ │
29+
│ │ ├─────────────────────────────────────────────────────────────┼────────────────────┼─────────────────────┤ │
30+
│ │ │ dagster.schedule │ Creates a schedule │ [scaffold-target] │ │
31+
│ │ │ │ following the │ │ │
32+
│ │ │ │ provided cron │ │ │
33+
│ │ │ │ schedule and │ │ │
34+
│ │ │ │ requests runs for │ │ │
35+
│ │ │ │ the provided job. │ │ │
36+
│ │ ├─────────────────────────────────────────────────────────────┼────────────────────┼─────────────────────┤ │
37+
│ │ │ dagster.sensor │ Creates a sensor │ [scaffold-target] │ │
38+
│ │ │ │ where the │ │ │
39+
│ │ │ │ decorated function │ │ │
40+
│ │ │ │ is used as the │ │ │
41+
│ │ │ │ sensor's │ │ │
42+
│ │ │ │ evaluation │ │ │
43+
│ │ │ │ function. │ │ │
2444
│ │ └─────────────────────────────────────────────────────────────┴────────────────────┴─────────────────────┘ │
2545
└─────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

0 commit comments

Comments
 (0)