Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Compatibility:

    There is no compatibility issue here because we use different configuration file names to ensure compatibility. The default configuration file will be changed to "flink-config.yaml" and parsed by the standard YAML parser. If users prefer to use the old parser, they can create a "flink-conf.yaml" file in the conf directory.

    Note that there are some behavior changes when using the standard YAML parser as follows:


    Standard YAML parser

    FLINK parser

    ConfigOption key

    The key of a ConfigOption cannot be a prefix of another option's key.

    No requirements.

    Comment

    Comments must be separated from other tokens by white space characters.

    Anything after the '#' symbol is considered a comment.

    Null value

    Parses null or blank values as null.

    Anything after the first ':' symbol is treated as a string type value, except for blank values.

    Special characters that need to be escaped when used in value

    Standard YAML have some indicator characters and they used

    Indicator character

    When using an indicator character as part of a string value, it is necessary to escape it in quotes to indicate that it is a string type.

    The indicator characters in standard YAML are as follows, and more details can be referred to at: https://yaml.org/spec/1.2.2/

    • -
    • ?
    • :
    • ,
    • [
    • ]
    • {
    • }
    • #
    • &
    • *
    • !
    • |
    • >
    • '
    • "
    • %
    • @

    FLINK parser require escape values by quotes when the config option key is List type or Map type has some special characters:

    • List type:
      • When the semicolon (;) is part of the value rather than a separator for list elements.
    • Map type:
      • When the comma (,) is part of the value rather than a separator for Map elements
      • When the colon (:) is part of the value rather than a separator for key-value pairs
    No requirements
      • .


  • Deprecation:

    The old configuration file "flink-conf.yaml" will be deprecated by announcing this change in the release notes and user documentation.

  • Migration Plan:

    In FLINK-2.0, the old parser will no longer be supported, nor will the flink-conf.yaml file be used as a configuration file.

...