Ctrl+K
Logo image Logo image

Site Navigation

  • API Reference
  • Examples

Site Navigation

  • API Reference
  • Examples

Section Navigation

  • PyFlink Table
    • TableEnvironment
    • Table
    • Data Types
    • Window
    • Expressions
    • User Defined Functions
    • Descriptors
    • StatementSet
    • Catalog
  • PyFlink DataStream
  • PyFlink Common

pyflink.table.table_descriptor.TableDescriptor.Builder.format#

Builder.format(format: Union[str, FormatDescriptor], format_option: Optional[ConfigOption[str]] = None) → Builder#

Defines the format to be used for this table.

Note that not every connector requires a format to be specified, while others may use multiple formats.

Example:

>>> TableDescriptor.for_connector("kafka")                 ...     .format(FormatDescriptor.for_format("json")
...                 .option("ignore-parse-errors", "true")
...                 .build())

will result in the options:

    'format' = 'json'
    'json.ignore-parse-errors' = 'true'

previous

pyflink.table.table_descriptor.TableDescriptor.Builder.option

next

pyflink.table.table_descriptor.TableDescriptor.Builder.partitioned_by

On this page
  • Builder.format()
Show Source

Created using Sphinx 5.3.0.