Skip to content

Commit fcd6d81

Browse files
committed
📄 docs: update readme file.
1 parent 462ae9f commit fcd6d81

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
11
# SQL Template
22

3-
A SQLPlate (SQL template) generator that is a generator object for SQL template
4-
statement.
3+
A SQLPlate (SQL template) provide the generator object for SQL template statements
4+
via Python API object.
5+
All SQL template files are store in the [Jinja template](https://jinja.palletsprojects.com/en/stable/templates/)
6+
format that is the powerful template tool package.
57

68
**The layer of SQL template files will be:**
79

810
```text
911
📂templates/
1012
├─ 📂databricks/
11-
│ ├─ 📜 etl.delta.sql
12-
│ ├─ 📜 etl.scd2.sql
13-
│ ╰─ 📜 select.sql
13+
│ ├─ 📜etl.delta.sql
14+
│ ├─ 📜etl.scd2.sql
15+
│ ╰─ 📜select.sql
1416
├─ 📂synapse-dedicate/
15-
│ ╰─ 📜 etl.delta.sql
17+
│ ╰─ 📜etl.delta.sql
1618
╰─ 📂utils/
17-
╰─ 📜 etl_vars.jinja
19+
╰─ ⚙️etl_vars.jinja
1820
```
1921

2022
## :package: Installation
@@ -93,16 +95,16 @@ WHEN NOT MATCHED THEN INSERT
9395

9496
## Systems
9597

96-
| System | Progress | Templates | Remark |
97-
|:-----------|:---------------:|:---------------------:|---------|
98-
| databricks | :yellow_circle: | etl.delta<br>etl.scd2 | |
99-
| sqlite | :yellow_circle: | | |
98+
| System | Progress | Templates | Remark |
99+
|:-----------|:--------:|:---------------------:|---------|
100+
| databricks | 🟡 | etl.delta<br>etl.scd2 | |
101+
| sqlite | 🟡 | | |
100102

101103
> [!NOTE]
102-
> - :green_circle: Complete
103-
> - :yellow_circle: In progress
104-
> - :red_circle: Does not develop
105-
> - :purple_circle: Does not plan to support
104+
> - 🟢 Complete
105+
> - 🟡 In progress
106+
> - 🔴 Does not develop
107+
> - 🟣 Does not plan to support
106108
107109
## :speech_balloon: Contribute
108110

0 commit comments

Comments
 (0)