Neptune Lab Mode - Amazon Neptune

Neptune Lab Mode

You can use Amazon Neptune lab mode to enable new features that are in the current Neptune engine release, but that aren't yet ready for production use and aren't enabled by default. This lets you try out these features in your development and test environments.

Note

This feature is available starting with Release 1.0.1.0.200463.0 (2019-10-15).

Using Neptune Lab Mode

Use the neptune_lab_mode DB cluster parameter to enable or disable features. You do this by including (feature name)=enabled or (feature name)=disabled in the value of the neptune_lab_mode parameter in the DB Cluster Parameter group.

For example, in this engine release you might set the neptune_lab_mode parameter to Streams=disabled, ReadWriteConflictDetection=enabled.

For information about how to edit the DB cluster parameter group for your database, see Editing a Parameter Group. Note that you cannot edit the default DB cluster parameter group; if you are using the default group, you must create a new DB cluster parameter group before you can set the neptune_lab_mode parameter.

Important

At present, if you supply the wrong lab-mode parameters or your request fails for another reason, you may not be notified of the failure. You should always verify that a lab-mode change request has succeeded by calling the status API as shown below:

curl -G https://your-neptune-endpoint:port/status

The status results include lab-mode information which will show whether or not the changes you requested were made:

{ "status":"healthy", "startTime":"Thu Jun 17 17:11:09 UTC 2021", "dbEngineVersion":"development", "role":"writer", "gremlin":{ "version":"tinkerpop-3.4.10" }, "sparql":{ "version":"sparql-1.1" }, "labMode":{ "ObjectIndex":"disabled", "DFEQueryEngine":"viaQueryHint", "ReadWriteConflictDetection":"enabled" }, "features":{ "LookupCache":{ "status":"Available" }, "IAMAuthentication":"disabled", "Streams":"disabled", "AuditLog":"disabled" }, "settings":{ "clusterQueryTimeoutInMs":"120000" } }

The following features are currently accessed using lab mode:

The Neptune DFE alternative query engine

Note

The DFE engine was first available in Neptune engine release 1.0.3.0, and starting in Neptune engine release 1.0.5.0, it became enabled by default for use with query hints, because DFEQueryEngine=viaQueryHint became the default lab-mode setting.

You can fully enable the new experimental Neptune DFE engine by setting DFEQueryEngine=enabled in the neptune_lab_mode DB cluster parameter, or you can disable it by setting DFEQueryEngine=disabled. The default setting is DFEQueryEngine=viaQueryHint, which means that the DFE engine is enabled, but will only be used for queries with the useDFE query hint present and set to true.

Note

When the DFE is enabled, DFE data statistics and openCypher support are also enabled.

The OSGP index

Neptune can now maintain a fourth index, namely the OSGP index, which is useful for data sets having a large number of predicates (see Enabling an OSGP Index).

Note

This feature is available starting in Neptune engine release 1.0.2.1.

You can enable an OSGP index in a new, empty Neptune DB cluster by setting ObjectIndex=enabled in the neptune_lab_mode DB cluster parameter. An OSGP index can only be enabled in a new, empty DB cluster.

By default, the OSGP index is disabled.

Warning

If you disable an enabled OSGP index by setting ObjectIndex=disabled after data has been added to the cluster, data will enter an inconsistent state. Rather than disable the index, move the data to a new DB cluster in which the OSGP index has not been enabled.

Formalized Transaction Semantics

Neptune has updated the formal semantics for concurrent transactions (see Transaction Semantics in Neptune).

Use ReadWriteConflictDetection as the name in the neptune_lab_mode parameter that enables or disables formalized transaction semantics.

By default, formalized transaction semantics are already enabled. If you want to revert to the earlier behavior, include ReadWriteConflictDetection=disabled in the value set for the DB Cluster neptune_lab_mode parameter.