
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Upgrading

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Table of Contents

1. Normal Upgrade
2. Special Upgrade
3. Upgrade 1.3.M03 → 1.3.M04
4. Upgrade 1.2 → 1.3
5. Upgrade 1.1 → 1.2

Normally a properly shutdown Neo4j database can be upgraded directly
to a new minor version. A database can be upgraded from a minor
version to the next, e.g. 1.1 → 1.2, and 1.2 → 1.3, but you can not
jump directly from 1.1 → 1.3. The upgrade process is a one way step;
databases cannot be downgraded.

However, some upgrades make significant changes to the database
store. Neo4j will refuse to start when a significant upgrade is
required, requiring explicit upgrade configuration.


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

1. Normal Upgrade

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

To perform a normal upgrade (for minor changes to the database
store):

 1. download the newer version of Neo4j
 2. cleanly shutdown the database to upgrade, if it is running
 3. startup the database with the newer version of Neo4j


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

2. Special Upgrade

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

To perform a special upgrade (for significant changes to the database
store):

 1. make sure the database you are upgrading has been cleanly shut
    down
 2. set the Neo4j configuration parameter "allow_store_upgrade=true"
 3. start the database
 4. the upgrade will happen during startup and the process is done
    when the database has been successfully started
 5. "allow_store_upgrade=true" configuration parameter should be
    removed, set to "false" or commented out


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

3. Upgrade 1.3.M03 → 1.3.M04

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Warning

Upgrading from 1.3.M03 → 1.3.M04 must be done explicitly since store
format has changed between those two versions.

The store format, as well as logical log format, have changed between
these two versions to allow for bigger stores.


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

4. Upgrade 1.2 → 1.3

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Warning

Upgrading from 1.2 → 1.3 must be done explicitly since store format
has changed between those two versions.

The store format, as well as logical log format, have changed between
these two versions to allow for bigger stores.

Important

Although id ranges has been increased the space used to store the
database will not increase compared to the previous version.

Upgrading between these two version needs to be performed explicitly
using a configuration parameter at startup (see "Special Upgrade").

Caution

Upgrade cannot be performed if either the number of relationship
types or the configured block size for either the dynamic array store
or string store is greater than 65534.

Caution

Indexes created using the old IndexService/LuceneIndexService are no
longer accessible out of the box in 1.3 in favor of the integrated
index. An automatic upgrade isn’t possible so a full rebuild of the
index data into the integrated index framework is required. For
reference the legacy index can be downloaded from the Neo4j
repository, http://m2.neo4j.org/org/neo4j/neo4j-legacy-index/


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

5. Upgrade 1.1 → 1.2

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Upgrading from Neo4j 1.1 to Neo4j 1.2 is a "normal" upgrade.

