feat(jdbc): add support for DatabaseMetaData#getSearchStringEscape

Closes: #595

Author: gotson

src/main/java/org/sqlite/jdbc3/JDBC3DatabaseMetaData.java

@@ -248,7 +248,7 @@ public String getProcedureTerm() {
 
     /** @see java.sql.DatabaseMetaData#getSearchStringEscape() */
     public String getSearchStringEscape() {
-        return null;
+        return "\\";
     }
 
     /** @see java.sql.DatabaseMetaData#getIdentifierQuoteString() */
@@ -850,7 +850,7 @@ public ResultSet getColumns(String c, String s, String tblNamePattern, String co
         // create a Matrix Cursor for each of the tables
         // create a merge cursor from all the Matrix Cursors
         // and return the columname and type from:
-        //    "PRAGMA table_info(tablename)"
+        //    "PRAGMA table_xinfo(tablename)"
         // which returns data like this:
         //        sqlite> PRAGMA lastyear.table_info(gross_sales);
         //        cid|name|type|notnull|dflt_value|pk
@@ -1102,7 +1102,9 @@ public ResultSet getColumns(String c, String s, String tblNamePattern, String co
                         if (colNamePattern != null) {
                             sql.append(" where upper(cn) like upper('")
                                     .append(escape(colNamePattern))
-                                    .append("')");
+                                    .append("') ESCAPE '")
+                                    .append(getSearchStringEscape())
+                                    .append("'");
                         }
                     }
                 }
@@ -1714,7 +1716,10 @@ public synchronized ResultSet getTables(
         sql.append("  )").append("\n");
         sql.append(" WHERE TABLE_NAME LIKE '")
                 .append(tblNamePattern)
-                .append("' AND TABLE_TYPE IN (");
+                .append("' ESCAPE '")
+                .append(getSearchStringEscape())
+                .append("'")
+                .append(" AND TABLE_TYPE IN (");
 
         if (types == null || types.length == 0) {
             sql.append("'TABLE','VIEW'");

src/test/java/org/sqlite/DBMetaDataTest.java

@@ -84,6 +84,27 @@ public void getTables() throws SQLException {
         rs.close();
     }
 
+    @Test
+    public void getTablesWithEscape() throws SQLException {
+        stat.executeUpdate("create table 'table%with%wildcards'(c1 integer)");
+        stat.executeUpdate("create table 'table_with_wildcards'(c2 integer)");
+        stat.executeUpdate("create table 'tableXwithXwildcards'(c3 integer)");
+
+        String esc = meta.getSearchStringEscape();
+        try (ResultSet rs =
+                meta.getTables(null, null, "table_with_wildcards".replace("_", esc + "_"), null)) {
+            assertThat(rs.next()).isTrue();
+            assertThat(rs.getString("TABLE_NAME")).isEqualTo("table_with_wildcards");
+            assertThat(rs.next()).isFalse();
+        }
+        try (ResultSet rs =
+                meta.getTables(null, null, "table%with%wildcards".replace("%", esc + "%"), null)) {
+            assertThat(rs.next()).isTrue();
+            assertThat(rs.getString("TABLE_NAME")).isEqualTo("table%with%wildcards");
+            assertThat(rs.next()).isFalse();
+        }
+    }
+
     @Test
     public void getTableTypes() throws SQLException {
         ResultSet rs = meta.getTableTypes();
@@ -271,6 +292,25 @@ public void getColumnsIncludingGenerated() throws SQLException {
         assertThat(rs.next()).isFalse();
     }
 
+    @Test
+    public void getColumnsWithEscape() throws SQLException {
+        stat.executeUpdate("create table wildcard(col1 integer, co_1 integer, 'co%1' integer)");
+
+        String esc = meta.getSearchStringEscape();
+        try (ResultSet rs =
+                meta.getColumns(null, null, "wildcard", "co_1".replace("_", esc + "_"))) {
+            assertThat(rs.next()).isTrue();
+            assertThat(rs.getString("COLUMN_NAME")).isEqualTo("co_1");
+            assertThat(rs.next()).isFalse();
+        }
+        try (ResultSet rs =
+                meta.getColumns(null, null, "wildcard", "co%1".replace("%", esc + "%"))) {
+            assertThat(rs.next()).isTrue();
+            assertThat(rs.getString("COLUMN_NAME")).isEqualTo("co%1");
+            assertThat(rs.next()).isFalse();
+        }
+    }
+
     @Test
     public void numberOfgetImportedKeysCols() throws SQLException {