提交 208fbead 编写于 作者: D Dawid Wysakowicz 提交者: Timo Walther

[hotfix][table-api-java] Improve documentation of withBuiltinCatalogName & withBuiltinDatabaseName

上级 589fd4d8
......@@ -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;
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册