You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2022/02/23 08:32:07 UTC
[GitHub] [flink] twalthr opened a new pull request #18895: [FLINK-26287][table] Add convenience method TableConfig.set
twalthr opened a new pull request #18895:
URL: https://github.com/apache/flink/pull/18895
## What is the purpose of the change
This slightly improves the configuration story by making `TableConfig` a `WritableConfig` that also supports the frequently used `set(String, String)` method by default.
## Brief change log
- Add `set(ConfigOption, T)`
- Add `set(String, String)`
## Verifying this change
This change is already covered by existing tests.
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): no
- The public API, i.e., is any changed class annotated with `@Public(Evolving)`: yes
- The serializers: no
- The runtime per-record code paths (performance sensitive): no
- Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: no
- The S3 file system connector: no
## Documentation
- Does this pull request introduce a new feature? no
- If yes, how is the feature documented? docs
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot commented on pull request #18895: [FLINK-26287][table] Add convenience method TableConfig.set
Posted by GitBox <gi...@apache.org>.
flinkbot commented on pull request #18895:
URL: https://github.com/apache/flink/pull/18895#issuecomment-1048552059
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "4c1588b40738ccaab6f4e3821ae0e6e6713950d7",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "4c1588b40738ccaab6f4e3821ae0e6e6713950d7",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 4c1588b40738ccaab6f4e3821ae0e6e6713950d7 UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #18895: [FLINK-26287][table] Add convenience method TableConfig.set
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #18895:
URL: https://github.com/apache/flink/pull/18895#issuecomment-1048552059
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "4c1588b40738ccaab6f4e3821ae0e6e6713950d7",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32093",
"triggerID" : "4c1588b40738ccaab6f4e3821ae0e6e6713950d7",
"triggerType" : "PUSH"
}, {
"hash" : "670400c8f787e726925fa6a9a38b154c661f3c4d",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32174",
"triggerID" : "670400c8f787e726925fa6a9a38b154c661f3c4d",
"triggerType" : "PUSH"
}, {
"hash" : "b94f415c82f03f443172feceb135c417c007354e",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "b94f415c82f03f443172feceb135c417c007354e",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 670400c8f787e726925fa6a9a38b154c661f3c4d Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32174)
* b94f415c82f03f443172feceb135c417c007354e UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] twalthr commented on a change in pull request #18895: [FLINK-26287][table] Add convenience method TableConfig.set
Posted by GitBox <gi...@apache.org>.
twalthr commented on a change in pull request #18895:
URL: https://github.com/apache/flink/pull/18895#discussion_r812688557
##########
File path: flink-table/flink-table-api-java/src/main/java/org/apache/flink/table/api/TableConfig.java
##########
@@ -81,6 +84,43 @@
/** A configuration object to hold all key/value configuration. */
private final Configuration configuration = new Configuration();
+ /**
+ * Sets a value for the given {@link ConfigOption}.
+ *
+ * <p>This method should be preferred over {@link #set(String, String)} as it is type-safe,
+ * avoids unnecessary parsing of the value, and provides inline documentation.
+ *
+ * <p>Note: Scala users might need to convert the value into a boxed type. E.g. by using {@code
+ * Int.box(1)} or {@code Boolean.box(false)}.
+ *
+ * @see TableConfigOptions
+ * @see ExecutionConfigOptions
+ * @see OptimizerConfigOptions
+ */
+ @Override
+ public <T> TableConfig set(ConfigOption<T> option, T value) {
+ configuration.set(option, value);
+ return this;
+ }
+
+ /**
+ * Sets a string-based value for the given string-based key.
+ *
+ * <p>The value will be parsed by the framework on access.
+ *
+ * <p>This method exists for convenience when configuring a session with string-based
+ * properties. Use {@link #set(ConfigOption, Object)} for more type-safety and inline
+ * documentation.
+ *
+ * @see TableConfigOptions
+ * @see ExecutionConfigOptions
+ * @see OptimizerConfigOptions
+ */
+ public TableConfig set(String key, String value) {
Review comment:
No, we all love type-safety but we should also be honest to ourselves that simple string keys are still a very (if not the most) common case. You can see it in the documentation as well. If you build a platform around the API, it will most likely the only case how you can configure Flink. Also in Python API it is the only possibility.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot commented on pull request #18895: [FLINK-26287][table] Add convenience method TableConfig.set
Posted by GitBox <gi...@apache.org>.
flinkbot commented on pull request #18895:
URL: https://github.com/apache/flink/pull/18895#issuecomment-1048551089
Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.
## Automated Checks
Last check on commit 4c1588b40738ccaab6f4e3821ae0e6e6713950d7 (Wed Feb 23 08:37:22 UTC 2022)
✅no warnings
<sub>Mention the bot in a comment to re-run the automated checks.</sub>
## Review Progress
* ❓ 1. The [description] looks good.
* ❓ 2. There is [consensus] that the contribution should go into to Flink.
* ❓ 3. Needs [attention] from.
* ❓ 4. The change fits into the overall [architecture].
* ❓ 5. Overall code [quality] is good.
Please see the [Pull Request Review Guide](https://flink.apache.org/contributing/reviewing-prs.html) for a full explanation of the review process.<details>
The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required <summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot approve description` to approve one or more aspects (aspects: `description`, `consensus`, `architecture` and `quality`)
- `@flinkbot approve all` to approve all aspects
- `@flinkbot approve-until architecture` to approve everything until `architecture`
- `@flinkbot attention @username1 [@username2 ..]` to require somebody's attention
- `@flinkbot disapprove architecture` to remove an approval you gave earlier
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #18895: [FLINK-26287][table] Add convenience method TableConfig.set
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #18895:
URL: https://github.com/apache/flink/pull/18895#issuecomment-1048552059
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "4c1588b40738ccaab6f4e3821ae0e6e6713950d7",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32093",
"triggerID" : "4c1588b40738ccaab6f4e3821ae0e6e6713950d7",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 4c1588b40738ccaab6f4e3821ae0e6e6713950d7 Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32093)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #18895: [FLINK-26287][table] Add convenience method TableConfig.set
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #18895:
URL: https://github.com/apache/flink/pull/18895#issuecomment-1048552059
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "4c1588b40738ccaab6f4e3821ae0e6e6713950d7",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32093",
"triggerID" : "4c1588b40738ccaab6f4e3821ae0e6e6713950d7",
"triggerType" : "PUSH"
}, {
"hash" : "670400c8f787e726925fa6a9a38b154c661f3c4d",
"status" : "PENDING",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32174",
"triggerID" : "670400c8f787e726925fa6a9a38b154c661f3c4d",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 4c1588b40738ccaab6f4e3821ae0e6e6713950d7 Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32093)
* 670400c8f787e726925fa6a9a38b154c661f3c4d Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32174)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #18895: [FLINK-26287][table] Add convenience method TableConfig.set
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #18895:
URL: https://github.com/apache/flink/pull/18895#issuecomment-1048552059
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "4c1588b40738ccaab6f4e3821ae0e6e6713950d7",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32093",
"triggerID" : "4c1588b40738ccaab6f4e3821ae0e6e6713950d7",
"triggerType" : "PUSH"
}, {
"hash" : "670400c8f787e726925fa6a9a38b154c661f3c4d",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32174",
"triggerID" : "670400c8f787e726925fa6a9a38b154c661f3c4d",
"triggerType" : "PUSH"
}, {
"hash" : "b94f415c82f03f443172feceb135c417c007354e",
"status" : "PENDING",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32213",
"triggerID" : "b94f415c82f03f443172feceb135c417c007354e",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 670400c8f787e726925fa6a9a38b154c661f3c4d Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32174)
* b94f415c82f03f443172feceb135c417c007354e Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32213)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] twalthr closed pull request #18895: [FLINK-26287][table] Add convenience method TableConfig.set
Posted by GitBox <gi...@apache.org>.
twalthr closed pull request #18895:
URL: https://github.com/apache/flink/pull/18895
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #18895: [FLINK-26287][table] Add convenience method TableConfig.set
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #18895:
URL: https://github.com/apache/flink/pull/18895#issuecomment-1048552059
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "4c1588b40738ccaab6f4e3821ae0e6e6713950d7",
"status" : "PENDING",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32093",
"triggerID" : "4c1588b40738ccaab6f4e3821ae0e6e6713950d7",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 4c1588b40738ccaab6f4e3821ae0e6e6713950d7 Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32093)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #18895: [FLINK-26287][table] Add convenience method TableConfig.set
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #18895:
URL: https://github.com/apache/flink/pull/18895#issuecomment-1048552059
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "4c1588b40738ccaab6f4e3821ae0e6e6713950d7",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32093",
"triggerID" : "4c1588b40738ccaab6f4e3821ae0e6e6713950d7",
"triggerType" : "PUSH"
}, {
"hash" : "670400c8f787e726925fa6a9a38b154c661f3c4d",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "670400c8f787e726925fa6a9a38b154c661f3c4d",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 4c1588b40738ccaab6f4e3821ae0e6e6713950d7 Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32093)
* 670400c8f787e726925fa6a9a38b154c661f3c4d UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] matriv commented on a change in pull request #18895: [FLINK-26287][table] Add convenience method TableConfig.set
Posted by GitBox <gi...@apache.org>.
matriv commented on a change in pull request #18895:
URL: https://github.com/apache/flink/pull/18895#discussion_r812682310
##########
File path: flink-table/flink-table-api-java/src/main/java/org/apache/flink/table/api/TableConfig.java
##########
@@ -81,6 +84,43 @@
/** A configuration object to hold all key/value configuration. */
private final Configuration configuration = new Configuration();
+ /**
+ * Sets a value for the given {@link ConfigOption}.
+ *
+ * <p>This method should be preferred over {@link #set(String, String)} as it is type-safe,
+ * avoids unnecessary parsing of the value, and provides inline documentation.
+ *
+ * <p>Note: Scala users might need to convert the value into a boxed type. E.g. by using {@code
+ * Int.box(1)} or {@code Boolean.box(false)}.
+ *
+ * @see TableConfigOptions
+ * @see ExecutionConfigOptions
+ * @see OptimizerConfigOptions
+ */
+ @Override
+ public <T> TableConfig set(ConfigOption<T> option, T value) {
+ configuration.set(option, value);
+ return this;
+ }
+
+ /**
+ * Sets a string-based value for the given string-based key.
+ *
+ * <p>The value will be parsed by the framework on access.
+ *
+ * <p>This method exists for convenience when configuring a session with string-based
+ * properties. Use {@link #set(ConfigOption, Object)} for more type-safety and inline
+ * documentation.
+ *
+ * @see TableConfigOptions
+ * @see ExecutionConfigOptions
+ * @see OptimizerConfigOptions
+ */
+ public TableConfig set(String key, String value) {
Review comment:
Is there no way to avoid this and force the usage of the type safe `set()`?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #18895: [FLINK-26287][table] Add convenience method TableConfig.set
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #18895:
URL: https://github.com/apache/flink/pull/18895#issuecomment-1048552059
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "4c1588b40738ccaab6f4e3821ae0e6e6713950d7",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32093",
"triggerID" : "4c1588b40738ccaab6f4e3821ae0e6e6713950d7",
"triggerType" : "PUSH"
}, {
"hash" : "670400c8f787e726925fa6a9a38b154c661f3c4d",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32174",
"triggerID" : "670400c8f787e726925fa6a9a38b154c661f3c4d",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 670400c8f787e726925fa6a9a38b154c661f3c4d Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32174)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #18895: [FLINK-26287][table] Add convenience method TableConfig.set
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #18895:
URL: https://github.com/apache/flink/pull/18895#issuecomment-1048552059
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "4c1588b40738ccaab6f4e3821ae0e6e6713950d7",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32093",
"triggerID" : "4c1588b40738ccaab6f4e3821ae0e6e6713950d7",
"triggerType" : "PUSH"
}, {
"hash" : "670400c8f787e726925fa6a9a38b154c661f3c4d",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32174",
"triggerID" : "670400c8f787e726925fa6a9a38b154c661f3c4d",
"triggerType" : "PUSH"
}, {
"hash" : "b94f415c82f03f443172feceb135c417c007354e",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32213",
"triggerID" : "b94f415c82f03f443172feceb135c417c007354e",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* b94f415c82f03f443172feceb135c417c007354e Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=32213)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org