You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by tw...@apache.org on 2019/07/30 09:32:15 UTC
[flink] 01/06: [hotfix][table-api-java] Improve documentation of
withBuiltinCatalogName & withBuiltinDatabaseName
This is an automated email from the ASF dual-hosted git repository.
twalthr pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 208fbead6aff45751e77fc0aac084e0244466d4f
Author: Dawid Wysakowicz <dw...@apache.org>
AuthorDate: Thu Jul 18 14:42:23 2019 +0200
[hotfix][table-api-java] Improve documentation of withBuiltinCatalogName & withBuiltinDatabaseName
---
.../flink/table/api/EnvironmentSettings.java | 22 +++++++++++++++++++---
1 file changed, 19 insertions(+), 3 deletions(-)
diff --git a/flink-table/flink-table-api-java/src/main/java/org/apache/flink/table/api/EnvironmentSettings.java b/flink-table/flink-table-api-java/src/main/java/org/apache/flink/table/api/EnvironmentSettings.java
index 8289bbc..bfd9203 100644
--- a/flink-table/flink-table-api-java/src/main/java/org/apache/flink/table/api/EnvironmentSettings.java
+++ b/flink-table/flink-table-api-java/src/main/java/org/apache/flink/table/api/EnvironmentSettings.java
@@ -22,6 +22,8 @@ import org.apache.flink.annotation.Internal;
import org.apache.flink.annotation.PublicEvolving;
import org.apache.flink.table.delegation.Executor;
import org.apache.flink.table.delegation.Planner;
+import org.apache.flink.table.functions.ScalarFunction;
+import org.apache.flink.table.sinks.TableSink;
import javax.annotation.Nullable;
@@ -212,7 +214,14 @@ public class EnvironmentSettings {
/**
* Specifies the name of the initial catalog to be created when instantiating
- * a {@link TableEnvironment}. Default: "default_catalog".
+ * a {@link TableEnvironment}. This catalog will be used to store all
+ * non-serializable objects such as tables and functions registered via e.g.
+ * {@link TableEnvironment#registerTableSink(String, TableSink)} or
+ * {@link TableEnvironment#registerFunction(String, ScalarFunction)}. It will
+ * also be the initial value for the current catalog which can be altered via
+ * {@link TableEnvironment#useCatalog(String)}.
+ *
+ * <p>Default: "default_catalog".
*/
public Builder withBuiltInCatalogName(String builtInCatalogName) {
this.builtInCatalogName = builtInCatalogName;
@@ -220,8 +229,15 @@ public class EnvironmentSettings {
}
/**
- * Specifies the name of the default database in the initial catalog to be created when instantiating
- * a {@link TableEnvironment}. Default: "default_database".
+ * Specifies the name of the default database in the initial catalog to be
+ * created when instantiating a {@link TableEnvironment}. The database will be
+ * used to store all non-serializable objects such as tables and functions registered
+ * via e.g. {@link TableEnvironment#registerTableSink(String, TableSink)} or
+ * {@link TableEnvironment#registerFunction(String, ScalarFunction)}. It will
+ * also be the initial value for the current database which can be altered via
+ * {@link TableEnvironment#useDatabase(String)}.
+ *
+ * <p>Default: "default_database".
*/
public Builder withBuiltInDatabaseName(String builtInDatabaseName) {
this.builtInDatabaseName = builtInDatabaseName;