[JDBC] Add Javadoc to IoTDBConnectionParams public methods and class#17517
Open
Ishani-10 wants to merge 1 commit intoapache:masterfrom
Open
[JDBC] Add Javadoc to IoTDBConnectionParams public methods and class#17517Ishani-10 wants to merge 1 commit intoapache:masterfrom
Ishani-10 wants to merge 1 commit intoapache:masterfrom
Conversation
All public methods, the constructor, and the class declaration in IoTDBConnectionParams.java were missing Javadoc documentation. Added Javadoc comments covering: - Class-level description explaining the role of this class in JDBC URL parsing - Constructor: documents the url parameter - All getter and setter pairs: documents return values and parameters - Special cases: setNetworkTimeout (negative value handling), setUseSSL (trustStore dependency), getSqlDialect (tree vs table dialect explanation), getDb (Optional semantics) No functional changes. Documentation only.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
All public methods, the constructor, and the class declaration in
IoTDBConnectionParams.javawere missing Javadoc documentation.Changes
Added Javadoc comments to:
urlparametergetHost()/setHost(): host connection parametergetPort()/setPort(): port connection parametergetJdbcUriString()/setJdbcUriString(): full JDBC URIgetSeriesName()/setSeriesName(): time-series path prefixgetUsername()/setUsername(): authentication credentialsgetPassword()/setPassword(): authentication credentialsgetThriftDefaultBufferSize()/setThriftDefaultBufferSize(): RPC buffergetThriftMaxFrameSize()/setThriftMaxFrameSize(): RPC frame sizegetVersion()/setVersion(): client version for compatibilitysetNetworkTimeout()/getNetworkTimeout(): timeout with negative-value handlingsetTimeZone()/getTimeZone(): timestamp formatting timezonesetCharset()/getCharset(): string encoding charsetisUseSSL()/setUseSSL(): SSL/TLS flag with trustStore dependency notegetTrustStore()/setTrustStore(): SSL trust store pathgetTrustStorePwd()/setTrustStorePwd(): SSL trust store passwordgetSqlDialect()/setSqlDialect(): tree vs table SQL dialectgetDb()/setDb(): Optional database name for Table Model contextType of Change
Notes
No functional changes. Documentation only.
I am a GSoC 2026 applicant for the Trino connector project for Apache IoTDB.
This contribution was motivated by reading this class while studying the JDBC
module for the connector design.