-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #59 from data-integrations/feature/fqn-multi-table…
…-source Emit lineage for the plugin
- Loading branch information
Showing
4 changed files
with
181 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| /* | ||
| * Copyright © 2023 Cask Data, Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not | ||
| * use this file except in compliance with the License. You may obtain a copy of | ||
| * the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| * License for the specific language governing permissions and limitations under | ||
| * the License. | ||
| */ | ||
|
|
||
| package io.cdap.plugin.util; | ||
|
|
||
| import io.opentracing.contrib.jdbc.ConnectionInfo; | ||
| import io.opentracing.contrib.jdbc.parser.URLParser; | ||
|
|
||
| /** | ||
| * Generate FQN from DB URL Connection. | ||
| * TODO: CDAP-20456 Reuse the class from hydrator/database-plugins module | ||
| */ | ||
| public final class FQNGenerator { | ||
|
|
||
| private static final String POSTGRESQL_TAG = "postgresql"; | ||
| private static final String POSTGRESQL_DEFAULT_SCHEMA = "public"; | ||
|
|
||
| private FQNGenerator() { } | ||
|
|
||
| public static String constructFQN(String jdbcUrl, String tableName) { | ||
| // dbtype, host, port, db from the connection string | ||
| // table is the reference name | ||
| ConnectionInfo connectionInfo = URLParser.parse(jdbcUrl); | ||
| // DB type as set by library after extraction | ||
| if (POSTGRESQL_TAG.equals(connectionInfo.getDbType())) { | ||
| // FQN for Postgresql | ||
| return String.format("%s://%s/%s.%s.%s", connectionInfo.getDbType(), connectionInfo.getDbPeer(), | ||
| connectionInfo.getDbInstance(), getPostgresqlSchema(jdbcUrl), tableName); | ||
| } else { | ||
| // FQN for MySQL, Oracle, SQLServer | ||
| return String.format("%s://%s/%s.%s", connectionInfo.getDbType(), connectionInfo.getDbPeer(), | ||
| connectionInfo.getDbInstance(), tableName); | ||
| } | ||
| } | ||
|
|
||
| private static String getPostgresqlSchema(String url) { | ||
| /** | ||
| * Extract schema for PostgresSQL URL strings which can be of the following formats | ||
| * jdbc:postgresql://{host}:{port}/{db}?currentSchema={schema} | ||
| * jdbc:postgresql://{host}:{port}/{db}?searchpath={schema} | ||
| */ | ||
| String dbSchema; | ||
| int offset = 0; | ||
| int startIndex = url.indexOf("connectionSchema="); | ||
| offset = 17; | ||
| if (startIndex == -1) { | ||
| startIndex = url.indexOf("searchpath="); | ||
| offset = 11; | ||
| } | ||
|
|
||
| int endIndex = url.indexOf("&", startIndex); | ||
| if (endIndex == -1) { | ||
| endIndex = url.length(); | ||
| } | ||
| if (startIndex != -1 && endIndex != -1 && startIndex <= endIndex) { | ||
| dbSchema = url.substring(startIndex + offset, endIndex); | ||
| } else { | ||
| dbSchema = POSTGRESQL_DEFAULT_SCHEMA; | ||
| } | ||
| return dbSchema; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| /* | ||
| * Copyright © 2023 Cask Data, Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not | ||
| * use this file except in compliance with the License. You may obtain a copy of | ||
| * the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| * License for the specific language governing permissions and limitations under | ||
| * the License. | ||
| */ | ||
|
|
||
| package io.cdap.plugin.util; | ||
|
|
||
| import org.junit.Assert; | ||
| import org.junit.Test; | ||
|
|
||
| /** | ||
| * Test class for FQNGenerator. | ||
| */ | ||
| public class FQNGeneratorTest { | ||
|
|
||
| @Test | ||
| public void testMySQLFQN() { | ||
| // Testcases consist of Connection URL, Table Name, Expected FQN String | ||
| String[][] testCases = {{"jdbc:mysql://localhost:1111/db", "table1", "mysql://localhost:1111/db.table1"}, | ||
| {"jdbc:mysql://34.35.36.37/db?useSSL=false", "table2", | ||
| "mysql://34.35.36.37:3306/db.table2"}}; | ||
| for (int i = 0; i < testCases.length; i++) { | ||
| String fqn = FQNGenerator.constructFQN(testCases[i][0], testCases[i][1]); | ||
| Assert.assertEquals(testCases[i][2], fqn); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void testSQLServerFQN() { | ||
| // Testcases consist of Connection URL, Table Name, Expected FQN String | ||
| String[][] testCases = {{"jdbc:sqlserver://;serverName=127.0.0.1;databaseName=DB", | ||
| "table1", "sqlserver://127.0.0.1:1433/DB.table1"}, | ||
| {"jdbc:sqlserver://localhost:1111;databaseName=DB;encrypt=true;user=user;password=pwd;", | ||
| "table2", "sqlserver://localhost:1111/DB.table2"}}; | ||
| for (int i = 0; i < testCases.length; i++) { | ||
| String fqn = FQNGenerator.constructFQN(testCases[i][0], testCases[i][1]); | ||
| Assert.assertEquals(testCases[i][2], fqn); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void testOracleFQN() { | ||
| // Testcases consist of Connection URL, Table Name, Expected FQN String | ||
| String[][] testCases = {{"jdbc:oracle:thin:@localhost:db", "table1", "oracle://localhost:1521/db.table1"}, | ||
| {"jdbc:oracle:thin:@test.server:1111/db", | ||
| "table2", "oracle://test.server:1111/db.table2"}}; | ||
| for (int i = 0; i < testCases.length; i++) { | ||
| String fqn = FQNGenerator.constructFQN(testCases[i][0], testCases[i][1]); | ||
| Assert.assertEquals(testCases[i][2], fqn); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void testPostgresqlFQN() { | ||
| // Testcases consist of Connection URL, Table Name, Expected FQN String | ||
| String[][] testCases = {{"jdbc:postgresql://34.35.36.37/test?user=user&password=secret&ssl=true", | ||
| "table1", "postgresql://34.35.36.37:5432/test.public.table1"}, | ||
| {"jdbc:postgresql://localhost/test?connectionSchema=schema", | ||
| "table2", "postgresql://localhost:5432/test.schema.table2"}, | ||
| {"jdbc:postgresql://localhost/test?searchpath=schema", | ||
| "table3", "postgresql://localhost:5432/test.schema.table3"}}; | ||
| for (int i = 0; i < testCases.length; i++) { | ||
| String fqn = FQNGenerator.constructFQN(testCases[i][0], testCases[i][1]); | ||
| Assert.assertEquals(testCases[i][2], fqn); | ||
| } | ||
| } | ||
| } |