Package org.elasticsearch.xpack.esql.core.type

Interface SupportedVersion

public interface SupportedVersion

  • Field Details

  • Method Details

    • supportedOn

      boolean supportedOn(TransportVersion version, boolean currentBuildIsSnapshot)

    • supportedLocally

      default boolean supportedLocally()

    • underConstruction

      default boolean underConstruction()

    • underConstruction

      static SupportedVersion underConstruction(TransportVersion createdVersion)
      Types that are actively being built. These types are
      • Not returned from Elasticsearch on release builds.
      • Not included in generated documentation
      • Not tested by ErrorsForCasesWithoutExamplesTestCase subclasses. When a function supports a type it includes a test case in its subclass of AbstractFunctionTestCase. If a function does not support them like TO_STRING then the tests won't notice. See class javadoc for instructions on adding new types, but that usually involves adding support for that type to a handful of functions. Once you've done that you should be able to turn your new type from under construction into released and update a few error messages.

      Snapshot builds treat these as supported starting from the version they were created on, so that we can write tests before actually turning on the support for the type. Mixed/multi cluster tests with older nodes should be skipped based on SNAPSHOT-only capabilites, as always.

    • supportedSince

      static SupportedVersion supportedSince(TransportVersion createdVersion, TransportVersion supportedVersion)
      Types that are supported starting with the given version.

      Snapshot builds treat these as supported from their created version onward, so that any existing tests using them should continue to work.