Skip to content

JDBC catalog fix namespaceExists check #8340

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

Merged
amogh-jahagirdar merged 11 commits into from
Dec 13, 2023
Merged

JDBC catalog fix namespaceExists check #8340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
2046a40
JDBC catalog fix namespaceExists check
ismailsimsek Aug 16, 2023
a012950
Improve testCreateNamespace test
ismailsimsek Oct 20, 2023
4aa7289
Improve testCreateNamespace test
ismailsimsek Oct 21, 2023
cfc874c
Improve testCreateNamespace test
ismailsimsek Oct 21, 2023
ec6d062
Improve testCreateNamespace test
ismailsimsek Oct 21, 2023
14c2a5e
Improve testCreateNamespace test
ismailsimsek Oct 21, 2023
6508e2b
Improve testCreateNamespace test
ismailsimsek Oct 21, 2023
0718c83
Split tests to testCreateNamespaceWithSpecialCharacter
ismailsimsek Oct 25, 2023
05d6d84
Organize and split testCreateNamespace tests
ismailsimsek Oct 25, 2023
ec812f9
Temoved test with `.`, and extended testCreateNamespaceWithBackslashC…
ismailsimsek Oct 28, 2023
61dcb2e
Add review improvements
ismailsimsek Dec 7, 2023
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
25 changes: 21 additions & 4 deletions core/src/main/java/org/apache/iceberg/jdbc/JdbcUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,13 @@ final class JdbcUtil {
+ " WHERE "
+ CATALOG_NAME
+ " = ? AND "
+ " ( "
+ TABLE_NAMESPACE
+ " LIKE ? LIMIT 1";
+ " = ? OR "
Copy link
Contributor

@dramaticlly dramaticlly Oct 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you for separate out for both equality check and prefix check with escape.

+ TABLE_NAMESPACE
+ " LIKE ? ESCAPE '\\' "
+ " ) "
+ " LIMIT 1";
static final String LIST_NAMESPACES_SQL =
"SELECT DISTINCT "
+ TABLE_NAMESPACE
Expand Down Expand Up @@ -204,8 +209,12 @@ final class JdbcUtil {
+ " WHERE "
+ CATALOG_NAME
+ " = ? AND "
+ " ( "
+ NAMESPACE_NAME
+ " = ? OR "
+ NAMESPACE_NAME
+ " LIKE ? LIMIT 1";
+ " LIKE ? ESCAPE '\\' "
+ " ) ";
static final String INSERT_NAMESPACE_PROPERTIES_SQL =
"INSERT INTO "
+ NAMESPACE_PROPERTIES_TABLE_NAME
Expand Down Expand Up @@ -345,19 +354,27 @@ public static String deletePropertiesStatement(Set<String> properties) {

static boolean namespaceExists(
String catalogName, JdbcClientPool connections, Namespace namespace) {

String namespaceEquals = JdbcUtil.namespaceToString(namespace);
// when namespace has sub-namespace then additionally checking it with LIKE statement.
// catalog.db can exists as: catalog.db.ns1 or catalog.db.ns1.ns2
String namespaceStartsWith =
namespaceEquals.replace("\\", "\\\\").replace("_", "\\_").replace("%", "\\%") + ".%";
if (exists(
connections,
JdbcUtil.GET_NAMESPACE_SQL,
catalogName,
JdbcUtil.namespaceToString(namespace) + "%")) {
namespaceEquals,
namespaceStartsWith)) {
return true;
}

if (exists(
connections,
JdbcUtil.GET_NAMESPACE_PROPERTIES_SQL,
catalogName,
JdbcUtil.namespaceToString(namespace) + "%")) {
namespaceEquals,
namespaceStartsWith)) {
return true;
}

Expand Down
63 changes: 61 additions & 2 deletions core/src/test/java/org/apache/iceberg/jdbc/TestJdbcCatalog.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -601,15 +601,74 @@ public void testDropNamespace() {
public void testCreateNamespace() {
Namespace testNamespace = Namespace.of("testDb", "ns1", "ns2");
assertThat(catalog.namespaceExists(testNamespace)).isFalse();
// Test with no metadata
assertThat(catalog.namespaceExists(Namespace.of("testDb", "ns1"))).isFalse();
catalog.createNamespace(testNamespace);
assertThat(catalog.namespaceExists(testNamespace)).isTrue();
assertThat(catalog.namespaceExists(Namespace.of("testDb"))).isTrue();
assertThat(catalog.namespaceExists(Namespace.of("testDb", "ns1"))).isTrue();
assertThat(catalog.namespaceExists(Namespace.of("testDb", "ns1", "ns2"))).isTrue();
assertThat(catalog.namespaceExists(Namespace.of("ns1", "ns2"))).isFalse();
assertThat(catalog.namespaceExists(Namespace.of("testDb", "ns%"))).isFalse();
assertThat(catalog.namespaceExists(Namespace.of("testDb", "ns_"))).isFalse();
assertThat(catalog.namespaceExists(Namespace.of("testDb", "ns1", "ns2", "ns3"))).isFalse();
}

@Test
public void testCreateNamespaceWithBackslashCharacter() {
Namespace testNamespace = Namespace.of("test\\Db", "ns\\1", "ns3");
assertThat(catalog.namespaceExists(testNamespace)).isFalse();
catalog.createNamespace(testNamespace);
assertThat(catalog.namespaceExists(testNamespace)).isTrue();
assertThat(catalog.namespaceExists(Namespace.of("test\\Db", "ns\\1"))).isTrue();
// test that SQL special characters `%`,`.`,`_` are escaped and returns false
assertThat(catalog.namespaceExists(Namespace.of("test\\%Db", "ns\\.1"))).isFalse();
assertThat(catalog.namespaceExists(Namespace.of("test%Db", "ns\\.1"))).isFalse();
assertThat(catalog.namespaceExists(Namespace.of("test%Db"))).isFalse();
assertThat(catalog.namespaceExists(Namespace.of("test%"))).isFalse();
assertThat(catalog.namespaceExists(Namespace.of("test\\%"))).isFalse();
assertThat(catalog.namespaceExists(Namespace.of("test_Db", "ns\\.1"))).isFalse();
// test that backslash with `%` is escaped and treated correctly
testNamespace = Namespace.of("test\\%Db2", "ns1");
assertThat(catalog.namespaceExists(testNamespace)).isFalse();
catalog.createNamespace(testNamespace);
assertThat(catalog.namespaceExists(testNamespace)).isTrue();
assertThat(catalog.namespaceExists(Namespace.of("test\\%Db2"))).isTrue();
assertThat(catalog.namespaceExists(Namespace.of("test%Db2"))).isFalse();
assertThat(catalog.namespaceExists(Namespace.of("test\\_Db2"))).isFalse();
}

@Test
public void testCreateNamespaceWithPercentCharacter() {
Namespace testNamespace = Namespace.of("testDb%", "ns%1");
assertThat(catalog.namespaceExists(testNamespace)).isFalse();
catalog.createNamespace(testNamespace);
assertThat(catalog.namespaceExists(testNamespace)).isTrue();
assertThat(catalog.namespaceExists(Namespace.of("testDb%"))).isTrue();
// test that searching with SQL special characters `\`,`%` are escaped and returns false
assertThat(catalog.namespaceExists(Namespace.of("testDb\\%"))).isFalse();
assertThat(catalog.namespaceExists(Namespace.of("testDb"))).isFalse();
assertThat(catalog.namespaceExists(Namespace.of("tes%Db%"))).isFalse();
assertThat(catalog.namespaceExists(Namespace.of("testDb%", "ns%"))).isFalse();
}

@Test
public void testCreateNamespaceWithUnderscoreCharacter() {
Namespace testNamespace = Namespace.of("test_Db", "ns_1", "ns_");
catalog.createNamespace(testNamespace);
assertThat(catalog.namespaceExists(testNamespace)).isTrue();
assertThat(catalog.namespaceExists(Namespace.of("test_Db", "ns_1"))).isTrue();
// test that searching with SQL special characters `_`,`%` are escaped and returns false
assertThat(catalog.namespaceExists(Namespace.of("test_Db"))).isTrue();
assertThat(catalog.namespaceExists(Namespace.of("test_D_"))).isFalse();
assertThat(catalog.namespaceExists(Namespace.of("test_D%"))).isFalse();
assertThat(catalog.namespaceExists(Namespace.of("test_Db", "ns_"))).isFalse();
assertThat(catalog.namespaceExists(Namespace.of("test_Db", "ns_%"))).isFalse();
}

@Test
public void testCreateTableInNonExistingNamespace() {
try (JdbcCatalog jdbcCatalog = initCatalog("non_strict_jdbc_catalog", ImmutableMap.of())) {
Namespace namespace = Namespace.of("testDb", "ns1", "ns2");
Namespace namespace = Namespace.of("test\\D_b%", "ns1", "ns2");
TableIdentifier identifier = TableIdentifier.of(namespace, "someTable");
Assertions.assertThat(jdbcCatalog.namespaceExists(namespace)).isFalse();
Assertions.assertThat(jdbcCatalog.tableExists(identifier)).isFalse();
Expand Down