Skip to content

Commit 93a9602

Browse files
CaideyipiCaideyipi
committed
Improve JDBC driver metadata
1 parent eb4409d commit 93a9602

4 files changed

Lines changed: 186 additions & 11 deletions

File tree

‎iotdb-client/jdbc/src/main/java/org/apache/iotdb/jdbc/Config.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@ private Config() {
5151
static final int RETRY_NUM = 3;
5252
static final long RETRY_INTERVAL_MS = 1000;
5353

54+
static final int DRIVER_MAJOR_VERSION = 4;
55+
static final int DRIVER_MINOR_VERSION = 3;
56+
5457
public static final int DEFAULT_FETCH_SIZE = 5000;
5558
static final int DEFAULT_CONNECTION_TIMEOUT_MS = 0;
5659

‎iotdb-client/jdbc/src/main/java/org/apache/iotdb/jdbc/IoTDBAbstractDatabaseMetadata.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -606,12 +606,12 @@ public String getDriverName() throws SQLException {
606606

607607
@Override
608608
public int getDriverMajorVersion() {
609-
return 4;
609+
return Config.DRIVER_MAJOR_VERSION;
610610
}
611611

612612
@Override
613613
public int getDriverMinorVersion() {
614-
return 3;
614+
return Config.DRIVER_MINOR_VERSION;
615615
}
616616

617617
@Override

‎iotdb-client/jdbc/src/main/java/org/apache/iotdb/jdbc/IoTDBDriver.java‎

Lines changed: 81 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,10 @@
2020
package org.apache.iotdb.jdbc;
2121

2222
import org.apache.iotdb.jdbc.i18n.JdbcMessages;
23+
import org.apache.iotdb.rpc.RpcUtils;
2324

2425
import org.apache.thrift.transport.TTransportException;
26+
import org.apache.tsfile.common.conf.TSFileConfig;
2527
import org.osgi.service.component.annotations.Component;
2628

2729
import java.sql.Connection;
@@ -30,6 +32,8 @@
3032
import java.sql.DriverPropertyInfo;
3133
import java.sql.SQLException;
3234
import java.sql.SQLFeatureNotSupportedException;
35+
import java.time.ZoneId;
36+
import java.util.Arrays;
3337
import java.util.Properties;
3438
import java.util.logging.Logger;
3539
import java.util.regex.Pattern;
@@ -40,7 +44,12 @@ public class IoTDBDriver implements Driver {
4044
org.slf4j.LoggerFactory.getLogger(IoTDBDriver.class);
4145

4246
/** Is this driver JDBC compliant. */
43-
private static final boolean TSFILE_JDBC_COMPLIANT = false;
47+
private static final boolean IOTDB_JDBC_COMPLIANT = false;
48+
49+
private static final String[] BOOLEAN_CHOICES = {"true", "false"};
50+
private static final String[] SQL_DIALECT_CHOICES = {Constant.TREE, Constant.TABLE};
51+
private static final String[] VERSION_CHOICES =
52+
Arrays.stream(Constant.Version.values()).map(Enum::name).toArray(String[]::new);
4453

4554
static {
4655
try {
@@ -58,7 +67,7 @@ public IoTDBDriver() {
5867

5968
@Override
6069
public boolean acceptsURL(String url) {
61-
return Pattern.matches(TSFILE_URL_PREFIX, url);
70+
return url != null && Pattern.matches(TSFILE_URL_PREFIX, url);
6271
}
6372

6473
@Override
@@ -75,14 +84,12 @@ public Connection connect(String url, Properties info) throws SQLException {
7584

7685
@Override
7786
public int getMajorVersion() {
78-
// TODO Auto-generated method stub
79-
return 0;
87+
return Config.DRIVER_MAJOR_VERSION;
8088
}
8189

8290
@Override
8391
public int getMinorVersion() {
84-
// TODO Auto-generated method stub
85-
return 0;
92+
return Config.DRIVER_MINOR_VERSION;
8693
}
8794

8895
@Override
@@ -92,12 +99,77 @@ public Logger getParentLogger() throws SQLFeatureNotSupportedException {
9299

93100
@Override
94101
public DriverPropertyInfo[] getPropertyInfo(String url, Properties info) {
95-
// TODO Auto-generated method stub
96-
return new DriverPropertyInfo[0];
102+
Properties properties = info == null ? new Properties() : info;
103+
return new DriverPropertyInfo[] {
104+
createProperty(
105+
Config.AUTH_USER, Config.DEFAULT_USER, "User name for authentication.", properties),
106+
createSensitiveProperty(Config.AUTH_PASSWORD, "Password for authentication."),
107+
createProperty(
108+
Config.DEFAULT_BUFFER_CAPACITY,
109+
String.valueOf(RpcUtils.THRIFT_DEFAULT_BUF_CAPACITY),
110+
"Thrift default buffer capacity in bytes.",
111+
properties),
112+
createProperty(
113+
Config.THRIFT_FRAME_MAX_SIZE,
114+
String.valueOf(RpcUtils.THRIFT_FRAME_MAX_SIZE),
115+
"Thrift max frame size in bytes.",
116+
properties),
117+
createProperty(
118+
Config.VERSION,
119+
Config.DEFAULT_VERSION.name(),
120+
VERSION_CHOICES,
121+
"Client compatibility version.",
122+
properties),
123+
createProperty(
124+
Config.NETWORK_TIMEOUT,
125+
String.valueOf(Config.DEFAULT_CONNECTION_TIMEOUT_MS),
126+
"Network timeout in milliseconds.",
127+
properties),
128+
createProperty(
129+
Config.TIME_ZONE, ZoneId.systemDefault().toString(), "Connection time zone.", properties),
130+
createProperty(
131+
Config.CHARSET, TSFileConfig.STRING_CHARSET.name(), "Connection charset.", properties),
132+
createProperty(
133+
Config.USE_SSL, "false", BOOLEAN_CHOICES, "Whether to enable SSL.", properties),
134+
createProperty(Config.TRUST_STORE, null, "SSL trust store path.", properties),
135+
createSensitiveProperty(Config.TRUST_STORE_PWD, "SSL trust store password."),
136+
createProperty(
137+
Config.SQL_DIALECT,
138+
Constant.TREE,
139+
SQL_DIALECT_CHOICES,
140+
"SQL dialect for the connection.",
141+
properties)
142+
};
97143
}
98144

99145
@Override
100146
public boolean jdbcCompliant() {
101-
return TSFILE_JDBC_COMPLIANT;
147+
return IOTDB_JDBC_COMPLIANT;
148+
}
149+
150+
private static DriverPropertyInfo createProperty(
151+
String name, String defaultValue, String description, Properties properties) {
152+
return createProperty(name, defaultValue, null, description, properties);
153+
}
154+
155+
private static DriverPropertyInfo createSensitiveProperty(String name, String description) {
156+
DriverPropertyInfo propertyInfo = new DriverPropertyInfo(name, null);
157+
propertyInfo.required = false;
158+
propertyInfo.description = description;
159+
return propertyInfo;
160+
}
161+
162+
private static DriverPropertyInfo createProperty(
163+
String name,
164+
String defaultValue,
165+
String[] choices,
166+
String description,
167+
Properties properties) {
168+
DriverPropertyInfo propertyInfo =
169+
new DriverPropertyInfo(name, properties.getProperty(name, defaultValue));
170+
propertyInfo.required = false;
171+
propertyInfo.choices = choices;
172+
propertyInfo.description = description;
173+
return propertyInfo;
102174
}
103175
}

‎iotdb-client/jdbc/src/test/java/org/apache/iotdb/jdbc/IoTDBDriverTest.java‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
20+
package org.apache.iotdb.jdbc;
21+
22+
import org.junit.Test;
23+
24+
import java.sql.DriverPropertyInfo;
25+
import java.util.Arrays;
26+
import java.util.Properties;
27+
28+
import static org.junit.Assert.assertEquals;
29+
import static org.junit.Assert.assertFalse;
30+
import static org.junit.Assert.assertNotNull;
31+
import static org.junit.Assert.assertNull;
32+
import static org.junit.Assert.assertTrue;
33+
import static org.junit.Assert.fail;
34+
35+
public class IoTDBDriverTest {
36+
37+
@Test
38+
public void testAcceptsUrl() {
39+
IoTDBDriver driver = new IoTDBDriver();
40+
41+
assertTrue(driver.acceptsURL("jdbc:iotdb://localhost:6667"));
42+
assertFalse(driver.acceptsURL(null));
43+
assertFalse(driver.acceptsURL("jdbc:mysql://localhost:3306"));
44+
}
45+
46+
@Test
47+
public void testDriverVersion() {
48+
IoTDBDriver driver = new IoTDBDriver();
49+
50+
assertEquals(Config.DRIVER_MAJOR_VERSION, driver.getMajorVersion());
51+
assertEquals(Config.DRIVER_MINOR_VERSION, driver.getMinorVersion());
52+
}
53+
54+
@Test
55+
public void testGetPropertyInfo() {
56+
IoTDBDriver driver = new IoTDBDriver();
57+
Properties properties = new Properties();
58+
properties.setProperty(Config.AUTH_USER, "root");
59+
properties.setProperty(Config.AUTH_PASSWORD, "secret");
60+
properties.setProperty(Config.USE_SSL, "true");
61+
properties.setProperty(Config.TRUST_STORE_PWD, "trust-store-secret");
62+
63+
DriverPropertyInfo[] propertyInfos =
64+
driver.getPropertyInfo("jdbc:iotdb://localhost:6667", properties);
65+
66+
assertTrue(propertyInfos.length > 0);
67+
assertEquals("root", findProperty(propertyInfos, Config.AUTH_USER).value);
68+
assertNull(findProperty(propertyInfos, Config.AUTH_PASSWORD).value);
69+
assertNull(findProperty(propertyInfos, Config.TRUST_STORE_PWD).value);
70+
assertEquals("true", findProperty(propertyInfos, Config.USE_SSL).value);
71+
assertEquals(
72+
Arrays.asList("true", "false"),
73+
Arrays.asList(findProperty(propertyInfos, Config.USE_SSL).choices));
74+
assertEquals(
75+
Arrays.asList(Constant.TREE, Constant.TABLE),
76+
Arrays.asList(findProperty(propertyInfos, Config.SQL_DIALECT).choices));
77+
assertEquals(Config.DEFAULT_VERSION.name(), findProperty(propertyInfos, Config.VERSION).value);
78+
}
79+
80+
@Test
81+
public void testGetPropertyInfoAllowsNullProperties() {
82+
IoTDBDriver driver = new IoTDBDriver();
83+
84+
DriverPropertyInfo[] propertyInfos =
85+
driver.getPropertyInfo("jdbc:iotdb://localhost:6667", null);
86+
87+
assertNotNull(propertyInfos);
88+
assertEquals(Config.DEFAULT_USER, findProperty(propertyInfos, Config.AUTH_USER).value);
89+
}
90+
91+
private static DriverPropertyInfo findProperty(DriverPropertyInfo[] propertyInfos, String name) {
92+
for (DriverPropertyInfo propertyInfo : propertyInfos) {
93+
if (name.equals(propertyInfo.name)) {
94+
return propertyInfo;
95+
}
96+
}
97+
fail("Missing driver property: " + name);
98+
return null;
99+
}
100+
}

0 commit comments

Comments
 (0)