TableSchema (flink-table-common 1.11.3 API)

java.lang.Object
- org.apache.flink.table.api.TableSchema

```
@PublicEvolving
public class TableSchema
extends Object
```
A table schema that represents a table's structure with field names and data types.

嵌套类概要

嵌套类
限定符和类型类和说明

static class TableSchema.Builder
Builder for creating a TableSchema.

嵌套类
限定符和类型	类和说明
`static class`	`TableSchema.Builder` Builder for creating a `TableSchema`.

构造器概要

构造器
构造器和说明
`TableSchema(String[] fieldNames, org.apache.flink.api.common.typeinfo.TypeInformation<?>[] fieldTypes)` 已过时。 Use the `TableSchema.Builder` instead.

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`static TableSchema.Builder`	`builder()`
`TableSchema`	`copy()` Returns a deep copy of the table schema.
`boolean`	`equals(Object o)`
`static TableSchema`	`fromTypeInfo(org.apache.flink.api.common.typeinfo.TypeInformation<?> typeInfo)` 已过时。 This method will be removed soon. Use `DataTypes` to declare types.
`int`	`getFieldCount()` Returns the number of fields.
`Optional<DataType>`	`getFieldDataType(int fieldIndex)` Returns the specified data type for the given field index.
`Optional<DataType>`	`getFieldDataType(String fieldName)` Returns the specified data type for the given field name.
`DataType[]`	`getFieldDataTypes()` Returns all field data types as an array.
`Optional<String>`	`getFieldName(int fieldIndex)` Returns the specified name for the given field index.
`String[]`	`getFieldNames()` Returns all field names as an array.
`Optional<org.apache.flink.api.common.typeinfo.TypeInformation<?>>`	`getFieldType(int fieldIndex)` 已过时。 This method will be removed in future versions as it uses the old type system. It is recommended to use `getFieldDataType(int)` instead which uses the new type system based on `DataTypes`. Please make sure to use either the old or the new type system consistently to avoid unintended behavior. See the website documentation for more information.
`Optional<org.apache.flink.api.common.typeinfo.TypeInformation<?>>`	`getFieldType(String fieldName)` 已过时。 This method will be removed in future versions as it uses the old type system. It is recommended to use `getFieldDataType(String)` instead which uses the new type system based on `DataTypes`. Please make sure to use either the old or the new type system consistently to avoid unintended behavior. See the website documentation for more information.
`org.apache.flink.api.common.typeinfo.TypeInformation<?>[]`	`getFieldTypes()` 已过时。 This method will be removed in future versions as it uses the old type system. It is recommended to use `getFieldDataTypes()` instead which uses the new type system based on `DataTypes`. Please make sure to use either the old or the new type system consistently to avoid unintended behavior. See the website documentation for more information.
`Optional<UniqueConstraint>`	`getPrimaryKey()`
`Optional<TableColumn>`	`getTableColumn(int fieldIndex)` Returns the `TableColumn` instance for the given field index.
`Optional<TableColumn>`	`getTableColumn(String fieldName)` Returns the `TableColumn` instance for the given field name.
`List<TableColumn>`	`getTableColumns()` Returns all the `TableColumn`s for this table schema.
`List<WatermarkSpec>`	`getWatermarkSpecs()` Returns a list of the watermark specification which contains rowtime attribute and watermark strategy expression.
`int`	`hashCode()`
`DataType`	`toPhysicalRowDataType()` Converts all physical columns of this schema into a (possibly nested) row data type.
`DataType`	`toRowDataType()` Converts all columns of this schema into a (possibly nested) row data type.
`org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row>`	`toRowType()` 已过时。 Use `toRowDataType()` instead.
`String`	`toString()`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - TableSchema
```
@Deprecated
public TableSchema(String[] fieldNames,
                               org.apache.flink.api.common.typeinfo.TypeInformation<?>[] fieldTypes)
```
    已过时。 Use the TableSchema.Builder instead.
- 方法详细资料
  - copy
```
public TableSchema copy()
```
    Returns a deep copy of the table schema.
  - getFieldDataTypes
```
public DataType[] getFieldDataTypes()
```
    Returns all field data types as an array.
  - getFieldTypes
```
@Deprecated
public org.apache.flink.api.common.typeinfo.TypeInformation<?>[] getFieldTypes()
```
    已过时。 This method will be removed in future versions as it uses the old type system. It is recommended to use getFieldDataTypes() instead which uses the new type system based on DataTypes. Please make sure to use either the old or the new type system consistently to avoid unintended behavior. See the website documentation for more information.
  - getFieldDataType
```
public Optional<DataType> getFieldDataType(int fieldIndex)
```
    Returns the specified data type for the given field index.
    
    参数:
    
    fieldIndex - the index of the field
  - getFieldType
```
@Deprecated
public Optional<org.apache.flink.api.common.typeinfo.TypeInformation<?>> getFieldType(int fieldIndex)
```
    已过时。 This method will be removed in future versions as it uses the old type system. It is recommended to use getFieldDataType(int) instead which uses the new type system based on DataTypes. Please make sure to use either the old or the new type system consistently to avoid unintended behavior. See the website documentation for more information.
  - getFieldDataType
```
public Optional<DataType> getFieldDataType(String fieldName)
```
    Returns the specified data type for the given field name.
    
    参数:
    
    fieldName - the name of the field
  - getFieldType
```
@Deprecated
public Optional<org.apache.flink.api.common.typeinfo.TypeInformation<?>> getFieldType(String fieldName)
```
    已过时。 This method will be removed in future versions as it uses the old type system. It is recommended to use getFieldDataType(String) instead which uses the new type system based on DataTypes. Please make sure to use either the old or the new type system consistently to avoid unintended behavior. See the website documentation for more information.
  - getFieldCount
```
public int getFieldCount()
```
    Returns the number of fields.
  - getFieldNames
```
public String[] getFieldNames()
```
    Returns all field names as an array.
  - getFieldName
```
public Optional<String> getFieldName(int fieldIndex)
```
    Returns the specified name for the given field index.
    
    参数:
    
    fieldIndex - the index of the field
  - getTableColumn
```
public Optional<TableColumn> getTableColumn(int fieldIndex)
```
    Returns the TableColumn instance for the given field index.
    
    参数:
    
    fieldIndex - the index of the field
  - getTableColumn
```
public Optional<TableColumn> getTableColumn(String fieldName)
```
    Returns the TableColumn instance for the given field name.
    
    参数:
    
    fieldName - the name of the field
  - getTableColumns
```
public List<TableColumn> getTableColumns()
```
    Returns all the TableColumns for this table schema.
  - toRowDataType
```
public DataType toRowDataType()
```
    Converts all columns of this schema into a (possibly nested) row data type.
    Note: The returned row data type contains both physical and computed columns. Be careful when using this method in a table source or table sink. In many cases, toPhysicalRowDataType() might be more appropriate.
    
    另请参阅:
    
    DataTypes.ROW(Field...), toPhysicalRowDataType()
  - toPhysicalRowDataType
```
public DataType toPhysicalRowDataType()
```
    Converts all physical columns of this schema into a (possibly nested) row data type.
    Note: The returned row data type contains only physical columns. It does not include computed columns.
    
    另请参阅:
    
    DataTypes.ROW(Field...), toRowDataType()
  - toRowType
```
@Deprecated
public org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row> toRowType()
```
    已过时。 Use toRowDataType() instead.
  - getWatermarkSpecs
```
public List<WatermarkSpec> getWatermarkSpecs()
```
    Returns a list of the watermark specification which contains rowtime attribute and watermark strategy expression.
    NOTE: Currently, there is at most one WatermarkSpec in the list, because we don't support multiple watermarks definition yet. But in the future, we may support multiple watermarks.
  - getPrimaryKey
```
public Optional<UniqueConstraint> getPrimaryKey()
```
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - equals
```
public boolean equals(Object o)
```
    覆盖:
    
    equals 在类中 Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 Object
  - fromTypeInfo
```
@Deprecated
public static TableSchema fromTypeInfo(org.apache.flink.api.common.typeinfo.TypeInformation<?> typeInfo)
```
    已过时。 This method will be removed soon. Use DataTypes to declare types.
    
    Creates a table schema from a TypeInformation instance. If the type information is a CompositeType, the field names and types for the composite type are used to construct the TableSchema instance. Otherwise, a table schema with a single field is created. The field name is "f0" and the field type the provided type.
    
    参数:
    
    typeInfo - The TypeInformation from which the table schema is generated.
    
    返回:
    
    The table schema that was generated from the given TypeInformation.
  - builder
```
public static TableSchema.Builder builder()
```

类 TableSchema

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

TableSchema

方法详细资料

copy

getFieldDataTypes

getFieldTypes

getFieldDataType

getFieldType

getFieldDataType

getFieldType

getFieldCount

getFieldNames

getFieldName

getTableColumn

getTableColumn

getTableColumns

toRowDataType

toPhysicalRowDataType

toRowType

getWatermarkSpecs

getPrimaryKey

toString

equals

hashCode

fromTypeInfo

builder