Skip to content

Commit f86504c

Browse files
[SDP] GraphElementRegistry
1 parent c444d96 commit f86504c

File tree

1 file changed

+24
-9
lines changed

1 file changed

+24
-9
lines changed

docs/declarative-pipelines/GraphElementRegistry.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
# GraphElementRegistry
22

3-
`GraphElementRegistry` is an [abstraction](#contract) of [graph element registries](#implementations).
3+
`GraphElementRegistry` is an [abstraction](#contract) of [graph element registries](#implementations):
4+
5+
* [Output](#register_output)s
6+
* [Flow](#register_flow)s
7+
8+
Graph elements can be defined in Python and [SQL](#register_sql).
49

510
## Contract
611

@@ -13,16 +18,21 @@ register_output(
1318
) -> None
1419
```
1520

21+
Registers the given [Output](Output.md)
22+
1623
See:
1724

1825
* [SparkConnectGraphElementRegistry](SparkConnectGraphElementRegistry.md#register_output)
1926

20-
Used when:
27+
Used for the following:
2128

22-
* [create_sink](./index.md#create_sink) is used
23-
* [@create_streaming_table](./index.md#create_streaming_table), [@table](./index.md#table), [@materialized_view](./index.md#materialized_view), [@temporary_view](./index.md#temporary_view) decorators are used
29+
* [dp.create_sink](./index.md#create_sink)
30+
* [@dp.create_streaming_table](./index.md#create_streaming_table)
31+
* [@dp.table](./index.md#table)
32+
* [@dp.materialized_view](./index.md#materialized_view)
33+
* [@dp.temporary_view](./index.md#temporary_view)
2434

25-
### register_flow { #register_flow }
35+
### Register Flow { #register_flow }
2636

2737
```py
2838
register_flow(
@@ -31,15 +41,20 @@ register_flow(
3141
) -> None
3242
```
3343

44+
Registers the given [Flow](Flow.md)
45+
3446
See:
3547

3648
* [SparkConnectGraphElementRegistry](SparkConnectGraphElementRegistry.md#register_flow)
3749

38-
Used when:
50+
Used for the following:
3951

40-
* [@append_flow](./index.md#append_flow), [@table](./index.md#table), [@materialized_view](./index.md#materialized_view), [@temporary_view](./index.md#temporary_view) decorators are used
52+
* [@dp.append_flow](./index.md#append_flow)
53+
* [@dp.table](./index.md#table)
54+
* [@dp.materialized_view](./index.md#materialized_view)
55+
* [@dp.temporary_view](./index.md#temporary_view)
4156

42-
### register_sql { #register_sql }
57+
### Register SQL File { #register_sql }
4358

4459
```py
4560
register_sql(
@@ -55,7 +70,7 @@ See:
5570

5671
Used when:
5772

58-
* `pyspark.pipelines.cli` is requested to [register_definitions](#register_definitions)
73+
* Pipelines CLI is requested to [register graph element definitions (from SQL files)](#register_definitions)
5974

6075
## Implementations
6176

0 commit comments

Comments
 (0)