Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(ingest): Add test case and docs for SQL view ingestion #2709

Merged
merged 2 commits into from
Jun 16, 2021
Merged

feat(ingest): Add test case and docs for SQL view ingestion #2709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d308207
Update include_views default
kevinhu Jun 16, 2021
b999980
Create mysql view
kevinhu Jun 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions metadata-ingestion/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ source:
password: pass
host_port: localhost:1433
database: DemoDatabase
include_views: True
include_views: True # whether to include views, defaults to True
table_pattern:
deny:
- "^.*\\.sys_.*" # deny all tables that start with sys_
Expand Down Expand Up @@ -243,6 +243,7 @@ source:
password: pass
host_port: localhost:1433
database: DemoDatabase
include_views: True # whether to include views, defaults to True
uri_args:
# See https://docs.microsoft.com/en-us/sql/connect/odbc/dsn-connection-string-attribute?view=sql-server-ver15
driver: "ODBC Driver 17 for SQL Server"
Expand Down Expand Up @@ -317,6 +318,7 @@ source:
password: pass
host_port: localhost:5432
database: DemoDatabase
include_views: True # whether to include views, defaults to True
# table_pattern/schema_pattern is same as above
# options is same as above
```
Expand All @@ -337,6 +339,7 @@ source:
password: pass
host_port: example.something.us-west-2.redshift.amazonaws.com:5439
database: DemoDatabase
include_views: True # whether to include views, defaults to True
# table_pattern/schema_pattern is same as above
# options is same as above
```
Expand All @@ -358,6 +361,7 @@ source:
database: db_name
warehouse: "COMPUTE_WH" # optional
role: "sysadmin" # optional
include_views: True # whether to include views, defaults to True
# table_pattern/schema_pattern is same as above
# options is same as above
```
Expand Down Expand Up @@ -402,6 +406,7 @@ source:
host_port: localhost:5432
database: dbname
service_name: svc # omit database if using this option
include_views: True # whether to include views, defaults to True
# table_pattern/schema_pattern is same as above
# options is same as above
```
Expand Down Expand Up @@ -442,6 +447,7 @@ source:
options: # options is same as above
# See https://github.com/mxmzdlv/pybigquery#authentication for details.
credentials_path: "/path/to/keyfile.json" # optional
include_views: True # whether to include views, defaults to True
# table_pattern/schema_pattern is same as above
```

Expand All @@ -466,6 +472,7 @@ source:
# See https://docs.aws.amazon.com/athena/latest/ug/querying.html
# However, the athena driver will transparently fetch these results as you would expect from any other sql client.
work_group: athena_workgroup # "primary"
include_views: True # whether to include views, defaults to True
# table_pattern/schema_pattern is same as above
```

Expand All @@ -485,11 +492,11 @@ source:
config:
aws_region: # aws_region_name, i.e. "eu-west-1"
env: # environment for the DatasetSnapshot URN, one of "DEV", "EI", "PROD" or "CORP". Defaults to "PROD".

# Filtering patterns for databases and tables to scan
database_pattern: # Optional, to filter databases scanned, same as schema_pattern above.
table_pattern: # Optional, to filter tables scanned, same as table_pattern above.

# Credentials. If not specified here, these are picked up according to boto3 rules.
# (see https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html)
aws_access_key_id: # Optional.
Expand Down Expand Up @@ -541,6 +548,7 @@ source:
options: {} # same as above
schema_pattern: {} # same as above
table_pattern: {} # same as above
include_views: True # whether to include views, defaults to True
```

### MongoDB `mongodb`
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/src/datahub/ingestion/source/sql_common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ class SQLAlchemyConfig(ConfigModel):
table_pattern: AllowDenyPattern = AllowDenyPattern.allow_all()
view_pattern: AllowDenyPattern = AllowDenyPattern.allow_all()

include_views: Optional[bool] = False
include_views: Optional[bool] = True
include_tables: Optional[bool] = True

@abstractmethod
Expand Down
113 changes: 113 additions & 0 deletions metadata-ingestion/tests/integration/mysql/mysql_mce_golden.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,5 +299,118 @@
}
},
"proposedDelta": null
},
{
"auditHeader": null,
"proposedSnapshot": {
"com.linkedin.pegasus2avro.metadata.snapshot.DatasetSnapshot": {
"urn": "urn:li:dataset:(urn:li:dataPlatform:mysql,metagalaxy.metadata_index_view,PROD)",
"aspects": [
{
"com.linkedin.pegasus2avro.dataset.DatasetProperties": {
"customProperties": {
"view_definition": "CREATE ALGORITHM=UNDEFINED DEFINER=`root`@`localhost` SQL SECURITY DEFINER VIEW `metadata_index_view` AS select `metadata_index`.`id` AS `id`,`metadata_index`.`urn` AS `urn`,`metadata_index`.`path` AS `path`,`metadata_index`.`doubleVal` AS `doubleVal` from `metadata_index`",
"is_view": "True"
},
"externalUrl": null,
"description": null,
"uri": null,
"tags": []
}
},
{
"com.linkedin.pegasus2avro.schema.SchemaMetadata": {
"schemaName": "metagalaxy.metadata_index_view",
"platform": "urn:li:dataPlatform:mysql",
"version": 0,
"created": {
"time": 1615443388097,
"actor": "urn:li:corpuser:etl",
"impersonator": null
},
"lastModified": {
"time": 1615443388097,
"actor": "urn:li:corpuser:etl",
"impersonator": null
},
"deleted": null,
"dataset": null,
"cluster": null,
"hash": "",
"platformSchema": {
"com.linkedin.pegasus2avro.schema.MySqlDDL": {
"tableSchema": ""
}
},
"fields": [
{
"fieldPath": "id",
"jsonPath": null,
"nullable": true,
"description": null,
"type": {
"type": {
"com.linkedin.pegasus2avro.schema.NumberType": {}
}
},
"nativeDataType": "BIGINT()",
"recursive": false,
"globalTags": null,
"glossaryTerms": null
},
{
"fieldPath": "urn",
"jsonPath": null,
"nullable": true,
"description": null,
"type": {
"type": {
"com.linkedin.pegasus2avro.schema.StringType": {}
}
},
"nativeDataType": "VARCHAR(length=200)",
"recursive": false,
"globalTags": null,
"glossaryTerms": null
},
{
"fieldPath": "path",
"jsonPath": null,
"nullable": true,
"description": null,
"type": {
"type": {
"com.linkedin.pegasus2avro.schema.StringType": {}
}
},
"nativeDataType": "VARCHAR(length=150)",
"recursive": false,
"globalTags": null,
"glossaryTerms": null
},
{
"fieldPath": "doubleVal",
"jsonPath": null,
"nullable": true,
"description": null,
"type": {
"type": {
"com.linkedin.pegasus2avro.schema.NumberType": {}
}
},
"nativeDataType": "DOUBLE(asdecimal=True)",
"recursive": false,
"globalTags": null,
"glossaryTerms": null
}
],
"primaryKeys": null,
"foreignKeysSpecs": null
}
}
]
}
},
"proposedDelta": null
}
]
3 changes: 3 additions & 0 deletions metadata-ingestion/tests/integration/mysql/setup/setup.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,6 @@ CREATE TABLE metadata_index (
INDEX stringIndex (`urn`,`aspect`,`path`,`stringVal`),
INDEX doubleIndex (`urn`,`aspect`,`path`,`doubleVal`)
) COMMENT="This is a table comment";

-- create view for testing
CREATE VIEW metadata_index_view AS SELECT id, urn, path, doubleVal FROM metadata_index;