Skip to content

Commit b7fb965

Browse files
LucasRoeslerLucasRoesler
committed
feat: add custom config options
feat: decouple from the SQLAlchemy source feat: Add the Apache license Signed-off-by: Lucas Roesler <[email protected]>
1 parent b38f676 commit b7fb965

File tree

8 files changed

+449
-72
lines changed

8 files changed

+449
-72
lines changed

‎LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2022 Contiamo GmbH
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,41 +6,51 @@ A ingestion source to generate lineage for views in a Postgres database.
66

77
## Quick Start
88

9-
First install [Poetry](https://python-poetry.org/docs/#installation)
10-
11-
Now, start a database
9+
First install [Poetry](https://python-poetry.org/docs/#installation) and [task](https://taskfile.dev) and initialize the project
1210

1311
```sh
14-
docker compose up -f examples/docker-compose.yaml -d
12+
task setup
1513
```
1614

17-
Create some tables and views in your database using psql
15+
Now, start a database
1816

1917
```sh
20-
psql -U normal_user -d cool_db -h localhost -p 6432 -c "create table if not exists users ( id uuid primary key, name text, email text, age int);"
21-
psql -U normal_user -d cool_db -h localhost -p 6432 -c "create view names as select distinct(name) from users;"
18+
task start wait sample-view
2219
```
2320

2421
Now run the ingestion to the console
2522
```sh
26-
poetry install
27-
poetry run datahub ingest -c examples/recipe.yaml
23+
task run
2824
```
2925

3026
When it is successful, the output should include
3127

3228
```sh
3329
Source (datahub_postgres_lineage.ingestion.PostgresLineageSource) report:
3430
{'events_produced': '1',
35-
'events_produced_per_sec': '1',
36-
'event_ids': ['urn:li:dataset:(urn:li:dataPlatform:postgres,cool_db.public.names,PROD)-upstreamLineage'],
31+
'events_produced_per_sec': '26',
32+
'event_ids': ['urn:li:dataset:(urn:li:dataPlatform:postgres,cool_db.public.emails,PROD)-upstreamLineage'],
3733
'warnings': {},
3834
'failures': {},
39-
'soft_deleted_stale_entities': [],
40-
'tables_scanned': '0',
41-
'views_scanned': '0',
42-
'entities_profiled': '0',
43-
'filtered': [],
44-
'start_time': '2022-12-16 18:17:57.889983 (now).',
45-
'running_time': '0.59 seconds'}
46-
```
35+
'filtered': ['public.names'],
36+
'start_time': '2022-12-20 16:09:46.105046 (now).',
37+
'running_time': '0.04 seconds'}
38+
```
39+
40+
## Configuration
41+
42+
| Key | Description | Default |
43+
| --- | --- | --- |
44+
| `username` | The username to connect to the database | '' |
45+
| `password` | The password to connect to the database | '' |
46+
| `host_port` | The host and port to connect to the database | '' |
47+
| `database` | The database to connect to | '' |
48+
| `database_alias` | Alias to apply to database when ingesting. | '' |
49+
| `sqlalchemy_uri` | SQLAlchemy URI to connect to the database | '' |
50+
| `scheme` | The SQLAlchemy scheme to use | `postgressql+psycopg2` |
51+
| `schema_pattern` | | |
52+
| `schema_pattern.allow`| Regexp pattern to match schemas to include | `.*` |
53+
| `schema_pattern.deny` | Regexp pattern to match schemas to exclude, 'information_schema' and 'pg_catalog' are already excluded | '' |
54+
| `view_pattern` | | |
55+
| `view_pattern.allow` | Regexp pattern to match view names to include | `.*` |
56+
| `view_pattern.deny` | Regexp pattern to match view names to exclude | '' |

‎Taskfile.yaml

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
version: 3
2+
3+
env:
4+
VENV: '{{default (printf "%s/%s" .ROOT_DIR ".venv") .VENV}}'
5+
# ENV and CONFIG_DIR are used in local development only to locate the config and secrets files
6+
ENV: '{{default "local" .ENV}}'
7+
CONFIG_DIR: '{{default "./env" .CONFIG_DIR}}'
8+
PROJECT_NAME: '{{default "datahub-pg-lineage" .PROJECT_NAME}}'
9+
10+
dotenv:
11+
- "{{.CONFIG_DIR}}/{{.ENV}}/.env"
12+
- ".env"
13+
14+
tasks:
15+
debug:
16+
cmds:
17+
- "echo ENV: {{.ENV}}"
18+
- "echo VENV: {{.VENV}}"
19+
- "echo CONFIG_DIR: {{.CONFIG_DIR}}"
20+
21+
setup:
22+
desc: setup the development environment
23+
cmds:
24+
- poetry install
25+
26+
wait:
27+
cmds:
28+
- sleep {{.SLEEP}}
29+
vars:
30+
SLEEP: 5
31+
32+
run:
33+
desc: run the ingestion pipeline
34+
vars:
35+
recipe: '{{default (printf "env/%s/recipe.yaml" .ENV) .recipe }}'
36+
cmds:
37+
- poetry run datahub ingest -c {{.recipe}}
38+
39+
start:
40+
desc: start a local databases
41+
cmds:
42+
- >
43+
docker-compose
44+
-p {{.PROJECT_NAME}}
45+
-f env/local/docker-compose.yaml
46+
up -d
47+
status:
48+
- docker-compose -p {{.PROJECT_NAME}} -f env/local/docker-compose.yaml ps sample-db | grep 'sample-db'
49+
50+
stop:
51+
desc: stop the development databases
52+
cmds:
53+
- >
54+
docker-compose
55+
-p {{.PROJECT_NAME}}
56+
-f env/local/docker-compose.yaml
57+
down
58+
preconditions:
59+
- sh: docker-compose -p {{.PROJECT_NAME}} -f env/local/docker-compose.yaml ps sample-db | grep 'sample-db'
60+
msg: database is not running
61+
62+
clean:
63+
desc: remove the development databases
64+
cmds:
65+
- >
66+
docker-compose
67+
-p {{.PROJECT_NAME}}
68+
-f env/local/docker-compose.yaml
69+
down -v
70+
71+
sample-view:
72+
desc: create a sample view
73+
cmds:
74+
- psql -f env/local/sample.sql
75+
status:
76+
- psql -At -c "select 1 from information_schema.views where table_name = 'names'" | grep "1"
77+
- psql -At -c "select 1 from information_schema.views where table_name = 'emails'" | grep "1"
78+
79+
psql:
80+
interactive: true
81+
desc: open psql to the database
82+
cmds:
83+
- psql {{.CLI_ARGS}}

0 commit comments

Comments
 (0)