26. Upgrade Guide

This section contains general information on version upgrades, as well as version-specific changes that may affect the end user.

26.1. Compatibility Across Versions

26.1.1. Semantic Versioning

Starting with 2.0.0, GeoMesa is adhering to semantic versioning. Essentially, releases are broken down into major, minor and patch versions. For a version number like 2.0.1, 2 is the major version, 2.0 is the minor version, and 2.0.1 is the patch version.

Major version updates contain breaking public API changes. Minor version updates contain new or updated functionality that is backwards-compatible. Patch versions contain only backwards-compatible bug fixes. This delineation allows users to gauge the potential impact of updating versions.


Versions prior to 2.0.0 do not follow semantic versioning, and each release should be considered a major version change.

26.1.2. Compatibility

Semantic versioning makes API guarantees, but GeoMesa has several compatibility vectors to consider: Data Compatibility

Data compatibility refers to the ability to read and write data written with older versions of GeoMesa. GeoMesa fully supports data written with version 1.2.2 or later, and mostly supports data written with 1.1.0 or later.

Note that although later versions can read earlier data, the reverse is not necessarily true. Data written with a newer client may not be readable by an older client.

Data written with 1.2.1 or earlier can be migrated to a newer data format. See Upgrading Existing Indices for details (note that this functionality is currently only implemented for Accumulo). API Compatibility

The GeoMesa public API is not currently well defined, so API compatibility is only guaranteed at the GeoTools DataStore level. In the future, GeoMesa will clearly indicate which classes and methods are part of the public API. Non-public classes may change without warning between minor versions. Binary Compatibility

Binary compatibility refers to the ability to have different GeoMesa versions in a single environment. An environment may be a single process or span multiple servers (for example an ingest pipeline, a query client, and an analytics platform). For data stores with a distributed component (HBase and Accumulo), the environment includes both the client and the distributed code.

GeoMesa requires that all JARs in an environment are the same minor version, and that all JARs within a single JVM are the same patch version. Dependency Compatibility

Dependency compatibility refers to the ability to update GeoMesa without updating other components (e.g. Accumulo, HBase, Hadoop, Spark, GeoServer, etc). Generally, GeoMesa supports a range of dependency versions (e.g. Accumulo 1.6 to 1.9). Spark versions are more tightly coupled, due to the use of private Spark APIs. Pre-Release Code

GeoMesa sometimes provides modules in an alpha or beta state. Although they share the overall GeoMesa version number, such modules should be considered pre-1.0, and are not guaranteed to provide any forwards or backwards compatibility across versions. Pre-release modules will be clearly marked in the documentation.

26.1.3. Compatibility Matrix

  Major Minor Patch
Data Y Y Y
Binary N N Y
Dependencies N N Y

26.2. Version 2.1.0 Upgrade Guide

26.2.1. Converter Updates

The GeoMesa converter API has been updated and simplified. The old API has been deprecated, and while custom converters written against it should still work, users are encouraged to migrate to org.locationtech.geomesa.convert2.SimpleFeatureConverter. A compatibility bridge is provided so that all converters registered with either the new or old API will be available to both.

Converter definitions should continue to work the same, but some invalid definitions may start to fail due to stricter configuration parsing. XML Converter Namespaces

XML parsing is now namespace-aware. This shouldn’t affect most operations, but any custom converter functions that operate on the XML element objects may need to take this into account (for example, custom XPath querying).

26.2.2. Distributed Runtime Version Checks

To prevent unexpected bugs due to JAR version mismatches, GeoMesa can scan the distributed classpath to verify compatible versions on the distributed classpath. This behavior may be enabled by setting the system property geomesa.distributed.version.check=true.

26.2.3. Shapefile Ingestion

Shapefile ingestion through the GeoMesa command-line tools has changed to use a converter definition. This allows for on-the-fly modifications to the shapefile during ingestion, however the command now requires user confirmation. The previous behavior can be simulated by passing --force to the ingest command.

26.2.4. Delimited Text Auto-Ingestion

GeoMesa previously supported auto ingest of specially formatted delimited CSV and TSV files. This functionality has been replaced with standard ingest type inference, which works similarly but may create different results. Generally, the previous behavior can be replicated by using type inference to create a converter definition, then modifying the converter to set the feature ID to the first column ($1).

26.2.5. FileSystem Storage API Changes

The FileSystem Storage API is still considered beta-level software, and has been updated in this release. The DataStore API has not changed, however the internal class interfaces have changed in this release, potentially requiring changes in user code.

In addition, the format used to store metadata files has been updated, so older versions of GeoMesa will not be able to read metadata created with this version. When accessing older metadata for the first time, GeoMesa will update the files to the new format, potentially breaking any old clients still being used.

Finally, the update-metadata tools command has been replaced with manage-metadata.

26.2.6. Spark Version Update

GeoMesa now builds against Spark 2.3.1, and supports versions 2.2.x and 2.3.x.

26.2.7. Arrow Version Update

The version of Apache Arrow used for Arrow-encoded results has been updated from 0.6.0 to 0.10.0. Due to changes in the Arrow inter-process communication (IPC) format, clients may need to update to the same Arrow version.

26.2.8. Scalatra Version Update

The version of scalatra used for web servlets has been updated to 2.6.3. The new version requires json4s 3.5.4, which may require changes to the web server used to deploy the servlets.

26.3. Version 2.0.0 Upgrade Guide

26.3.1. GeoTools 18 and GeoServer 2.12

GeoMesa 2.0.0 is compiled against GeoTools 18.0 and GeoServer 2.12. When upgrading GeoServer instances, it’s usually best to start over with a new GeoServer data directory. If you upgrade GeoMesa in an existing GeoServer instance that has run GeoMesa 1.3.x or earlier, layers will still work but you will not be able to edit any existing GeoMesa stores. In order to edit stores, you will need to delete them and re-create them through the GeoServer UI. Alternatively, you may edit the GeoServer datastore.xml files (located in the GeoServer data directory) to match the new GeoMesa data store parameters (described below). In particular, you will need to add a namespace parameter that matches the workspace of the GeoServer store.

26.3.2. Data Store Parameters

The data store parameters used in calls to DataStoreFinder and the Spark SpatialRDDProvider have been standardized . New parameters are outlined in the individual data store pages:

The older parameter names will continue to work, but are deprecated and may be removed in future versions.

26.3.3. Removal of Joda Time

With the introduction of java.time in Java 8, the Joda Time project has been deprecated. As such, GeoMesa has removed its Joda dependency in favor of java.time. One consequence of this is that custom date patterns in geomesa-convert are interpreted slightly differently. See DateTimeFormatter for details.


In particular, “year of era” has changed from Y to y. Y now means “week-based year”, and will give different results.

26.3.4. Saxon XML Parser

The GeoMesa converter XML module now ships with Saxon-HE by default. Saxon-HE is generally much faster at parsing XML than the default Java implementation. Previously, Saxon was available as an additional download.


Saxon parsing has some differences from the default Java implementation, which may cause existing converter definitions to fail. In particular, Saxon is much stricter with XML namespaces. See Handling Namespaces with Saxon for more information.

26.3.5. Kafka Data Store

The Kafka Data Store has been rewritten into a single implementation for Kafka 0.9.x or later. Support for Kafka 0.8 has been removed. See Kafka Data Store for more information.

26.3.6. Accumulo Standardization

In order to standardize behavior between data store implementations, some behaviors of the AccumuloDataStore have been modified. Attribute Index Coverage

Accumulo attribute indices specified with index=true will now create full attribute indices, instead of join indices. To create a join index, explicitly specify index=join. Existing schemas are not affected. Record Index Identifier

The Accumulo record index has been renamed to the id index. In general practice, this will have no effect, however when specifying geomesa.indices.enabled, the value id must be used in place of records. Tools Command Name

The Accumulo command line tools script has been renamed from geomesa to geomesa-accumulo.

26.3.7. Table Splitters

The table splitting API has changed. Any custom table splitters implementing org.locationtech.geomesa.index.conf.TableSplitter will need to be updated for the new method signatures. In addition, the provided GeoMesa splitters have been deprecated and replaced. See Configuring Index Splits for more details.

26.3.8. System Properties

Time-related system properties have been standardized to all use readable durations. Durations can be specified as a number followed by a time unit, e.g. 10 minutes or 30 seconds. The following properties have been changed to accept durations, and some have been renamed. Note that this will affect system properties set in the JVM as well as any custom geomesa-site.xml files. More details can be found under Runtime Configuration or the appropriate data store configuration section.

Property Previous name
geomesa.query.timeout geomesa.query.timeout.millis
geomesa.metadata.expiry N/A
geomesa.batchwriter.latency geomesa.batchwriter.latency.millis
geomesa.batchwriter.latency geomesa.batchwriter.latency.millis
geomesa.stats.compact.interval geomesa.stats.compact.millis
geomesa.cassandra.read.timeout geomesa.cassandra.read.timeout.millis
geomesa.cassandra.connection.timeout geomesa.cassandra.connection.timeout.millis