Add adapter property to change table count limit #134
Conversation
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
…-virtual-schema can access them
- add tests for new table limit
- new methods JDBCAdapter::validateProperties and ::validateAdapterProperties - added parameter validation tests
- add property documentation in README
ckunki
requested changes
Feb 24, 2023
src/main/java/com/exasol/adapter/jdbc/BaseTableMetadataReader.java
Outdated
Show resolved
Hide resolved
src/test/java/com/exasol/adapter/jdbc/BaseTableMetadataReaderTest.java
Outdated
Show resolved
Hide resolved
src/test/java/com/exasol/adapter/jdbc/BaseTableMetadataReaderTest.java
Outdated
Show resolved
Hide resolved
Comment on lines
+169
to
+186
| protected void validateAdapterProperties(AdapterProperties properties) throws PropertyValidationException { | ||
| if (properties.containsKey(JDBC_MAXTABLES_PROPERTY)) { | ||
| int result = 0; | ||
| try { | ||
| result = Integer.parseUnsignedInt(properties.get(JDBC_MAXTABLES_PROPERTY)); | ||
| } catch (NumberFormatException e) { | ||
| // pass | ||
| } | ||
| if( result == 0 ) { | ||
| throw new PropertyValidationException(ExaError.messageBuilder("E-VSCJDBC-43") // | ||
| .message("Invalid parameter value.") // | ||
| .mitigation( | ||
| "The adapter property {{max_tables_property}}" + " if present, must be a positive integer.") // | ||
| .parameter("max_tables_property", JDBC_MAXTABLES_PROPERTY) // | ||
| .toString()); | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Suggested change
| protected void validateAdapterProperties(AdapterProperties properties) throws PropertyValidationException { | |
| if (properties.containsKey(JDBC_MAXTABLES_PROPERTY)) { | |
| int result = 0; | |
| try { | |
| result = Integer.parseUnsignedInt(properties.get(JDBC_MAXTABLES_PROPERTY)); | |
| } catch (NumberFormatException e) { | |
| // pass | |
| } | |
| if( result == 0 ) { | |
| throw new PropertyValidationException(ExaError.messageBuilder("E-VSCJDBC-43") // | |
| .message("Invalid parameter value.") // | |
| .mitigation( | |
| "The adapter property {{max_tables_property}}" + " if present, must be a positive integer.") // | |
| .parameter("max_tables_property", JDBC_MAXTABLES_PROPERTY) // | |
| .toString()); | |
| } | |
| } | |
| } | |
| protected void validateAdapterProperties(final AdapterProperties properties) throws PropertyValidationException { | |
| try { | |
| validatePropertyValue(properties.get(JDBC_MAXTABLES_PROPERTY)); | |
| } catch (final IllegalArgumentException exception) { | |
| throw new PropertyValidationException(ExaError.messageBuilder("E-VSCJDBC-43") // | |
| .message("Invalid parameter value.") // | |
| .mitigation("The adapter property {{max_tables_property}}" // | |
| + " if present, must be a positive integer.") // | |
| .parameter("max_tables_property", JDBC_MAXTABLES_PROPERTY) // | |
| .toString()); | |
| } | |
| } | |
| private void validatePropertyValue(final String string) { | |
| if (string == null) { | |
| return; | |
| } | |
| final int value = Integer.parseUnsignedInt(string); | |
| if (value == 0) { | |
| throw new IllegalArgumentException(); | |
| } | |
| } |
There was a problem hiding this comment.
Hmm.... the method was meant to be extendable with more property checks -- (property, value and error message) should all be in one place.
There was a problem hiding this comment.
I was tempted to think the same - please feel free!
Comment on lines
+188
to
+194
| // Validate properties for both the base adapter and the sql dialect | ||
| private void validateProperties(AdapterProperties properties) throws PropertyValidationException { | ||
| validateAdapterProperties(properties); | ||
| if( this.sqlDialectFactory != null ) { | ||
| this.sqlDialectFactory.createSqlDialect(null, properties).validateProperties(); | ||
| } | ||
| } |
There was a problem hiding this comment.
Dialect properties will be validated in method readMetaData() (two signatures).
But we could avoid code duplication in these methods:
Suggested change
| // Validate properties for both the base adapter and the sql dialect | |
| private void validateProperties(AdapterProperties properties) throws PropertyValidationException { | |
| validateAdapterProperties(properties); | |
| if( this.sqlDialectFactory != null ) { | |
| this.sqlDialectFactory.createSqlDialect(null, properties).validateProperties(); | |
| } | |
| } | |
| private SqlDialect createDialect(final AdapterProperties properties, final ExaMetadata exasolMetadata) | |
| throws PropertyValidationException { | |
| final ConnectionFactory connectionFactory = new RemoteConnectionFactory(exasolMetadata, properties); | |
| final SqlDialect dialect = createDialect(connectionFactory, properties); | |
| dialect.validateProperties(); | |
| return dialect; | |
| } |
| @@ -40,6 +42,7 @@ public CreateVirtualSchemaResponse createVirtualSchema(final ExaMetadata exasolM | |||
| final CreateVirtualSchemaRequest request) throws AdapterException { | |||
| logCreateVirtualSchemaRequestReceived(request); | |||
| final AdapterProperties properties = getPropertiesFromRequest(request); | |||
| validateProperties(properties); | |||
There was a problem hiding this comment.
Suggested change
| validateProperties(properties); | |
| validateAdapterProperties(properties); |
Comment on lines
+150
to
+152
|
|
||
| validateProperties(mergedProperties); | ||
|
|
There was a problem hiding this comment.
Dialect properties will be validated in method readMetaData()
Suggested change
| validateProperties(mergedProperties); | |
| validateAdapterProperties(mergedProperties); |
There was a problem hiding this comment.
But that reopens the problem that you can ALTER your virtual schema without any errors, and it will only explode on refresh or use...
There was a problem hiding this comment.
Is your concern, that isRefreshingVirtualSchemaRequired() might return false and hence avoiding a call to readMetadata()?
…java Co-authored-by: Christoph Kuhnke <github@kuhnke.net>
|
Kudos, SonarCloud Quality Gate passed! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
JDBCAdapterto validate properties on create and setProperty events.privatemembersprotected