pyflink.table.table_descriptor.TableDescriptor.Builder.format

Builder.format(format: Union[str, pyflink.table.table_descriptor.FormatDescriptor], format_option: Optional[pyflink.common.config_options.ConfigOption[str]] = None) → pyflink.table.table_descriptor.TableDescriptor.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'