Github user fhueske commented on a diff in the pull request:
https://github.com/apache/flink/pull/3039#discussion_r94851171
--- Diff:
flink-libraries/flink-table/src/main/scala/org/apache/flink/table/sources/TableSource.scala
---
@@ -19,21 +19,28 @@
package org.apache.flink.table.sources
import org.apache.flink.api.common.typeinfo.TypeInformation
+import org.apache.flink.table.api.TableEnvironment
-/** Defines an external table by providing schema information, i.e., field
names and types.
+/** Defines an external table by providing schema information and used to
produce a
+ * [[org.apache.flink.api.scala.DataSet]] or
[[org.apache.flink.streaming.api.scala.DataStream]].
+ * Schema information consists of a data type, field names, and
corresponding indices of
+ * these names in the data type.
+ *
+ * To define a TableSource one need to implement
[[TableSource#getReturnType]]. In this case
+ * field names and field indices are derived from the returned type.
+ *
+ * In case if custom field names are required one need to implement both
+ * [[TableSource#getFieldsNames]] and [[TableSource#getFieldsIndices]].
*
* @tparam T The return type of the [[TableSource]].
*/
trait TableSource[T] {
--- End diff --
Please rename `getFieldsNames()` to `getFieldNames()` (the original
`getFieldsNames() looks like a typo to me.`) and `getFieldsIndicies()` to
`getFieldIndicies()`.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
