twalthr commented on code in PR #25704:
URL: https://github.com/apache/flink/pull/25704#discussion_r1862089260
##########
flink-table/flink-table-api-java/src/main/java/org/apache/flink/table/api/TableEnvironment.java:
##########
@@ -718,6 +718,36 @@ void createTemporarySystemFunction(
*/
void createTemporaryTable(String path, TableDescriptor descriptor);
+ /**
+ * Registers the given {@link TableDescriptor} as a temporary catalog
table.
+ *
+ * <p>The {@link TableDescriptor descriptor} is converted into a {@link
CatalogTable} and stored
+ * in the catalog.
+ *
+ * <p>Temporary objects can shadow permanent ones. If a permanent object
in a given path exists,
+ * it will be inaccessible in the current session. To make the permanent
object available again
+ * one can drop the corresponding temporary object.
+ *
+ * <p>Examples:
+ *
+ * <pre>{@code
+ * tEnv.createTemporaryTable("MyTable",
TableDescriptor.forConnector("datagen")
+ * .schema(Schema.newBuilder()
+ * .column("f0", DataTypes.STRING())
+ * .build())
+ * .option(DataGenOptions.ROWS_PER_SECOND, 10)
+ * .option("fields.f0.kind", "random")
+ * .build());
Review Comment:
update example
##########
flink-table/flink-table-api-java/src/main/java/org/apache/flink/table/api/TableEnvironment.java:
##########
@@ -745,6 +775,35 @@ void createTemporarySystemFunction(
*/
void createTable(String path, TableDescriptor descriptor);
+ /**
+ * Registers the given {@link TableDescriptor} as a catalog table.
+ *
+ * <p>The {@link TableDescriptor descriptor} is converted into a {@link
CatalogTable} and stored
+ * in the catalog.
+ *
+ * <p>If the table should not be permanently stored in a catalog, use
{@link
+ * #createTemporaryTable(String, TableDescriptor)} instead.
+ *
+ * <p>Examples:
+ *
+ * <pre>{@code
+ * tEnv.createTable("MyTable", TableDescriptor.forConnector("datagen")
+ * .schema(Schema.newBuilder()
+ * .column("f0", DataTypes.STRING())
+ * .build())
+ * .option(DataGenOptions.ROWS_PER_SECOND, 10)
+ * .option("fields.f0.kind", "random")
+ * .build());
Review Comment:
update example
##########
flink-table/flink-table-api-java/src/main/java/org/apache/flink/table/api/TableEnvironment.java:
##########
@@ -745,6 +745,35 @@ void createTemporarySystemFunction(
*/
void createTable(String path, TableDescriptor descriptor);
+ /**
+ * Registers the given {@link TableDescriptor} as a catalog table.
+ *
+ * <p>The {@link TableDescriptor descriptor} is converted into a {@link
CatalogTable} and stored
+ * in the catalog.
+ *
+ * <p>If the table should not be permanently stored in a catalog, use
{@link
+ * #createTemporaryTable(String, TableDescriptor)} instead.
Review Comment:
update link
--
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-unsubscr...@flink.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
