Package org.neo4j.graphdb.schema

Interface IndexSetting

public interface IndexSetting
Index settings are used for fine-tuning the behaviour of schema indexes. All indexes have a configuration associated with them, and it is only necessary to specify the particular settings in that configuration, that should differ from their defaults.

Index settings can only be specified when the index is created. Once the index has been created, the index configuration becomes immutable.

Here is an example where a full-text index is created with a custom analyzer: 


     try ( Transaction tx = database.beginTx() )
     {
         tx.schema().indexFor( Label.label( "Email" ) ).on( "from" ).on( "to" ).on( "cc" ).on( "bcc" )
                 .withName( "email-addresses" )
                 .withIndexType( IndexType.FULLTEXT )
                 .withIndexConfiguration( Map.of( IndexSetting.fulltext_Analyzer(), "email" ) )
                 .create();
         tx.commit();
     }

  • Method Details

    • getSettingName

      String getSettingName()

    • getType

      Class<?> getType()

    • fulltext_Analyzer

      static IndexSetting fulltext_Analyzer()
      Configure the analyzer used in a full-text index, indexes of type IndexType.FULLTEXT.

      The list of possible analyzers are available via the db.index.fulltext.listAvailableAnalyzers() procedure.

      This setting is given as a String.

    • fulltext_Eventually_Consistent

      static IndexSetting fulltext_Eventually_Consistent()
      Configure if a full-text index is allowed to be eventually consistent. By default full-text indexes are fully consistent, just like other schema indexes.

      This setting is given as a boolean.

    • spatial_Cartesian_Min

      static IndexSetting spatial_Cartesian_Min()
      Fine tune behaviour for spatial values in point index, indexes of type IndexType.POINT.

      Configuration for cartesian coordinate reference system.

      Set min value for envelope in dimension order [minX, minY].

    • spatial_Cartesian_Max

      static IndexSetting spatial_Cartesian_Max()
      Fine tune behaviour for spatial values in point index, indexes of type IndexType.POINT.

      Configuration for cartesian coordinate reference system.

      Set max value for envelope in dimension order [maxX, maxY].

    • spatial_Cartesian_3D_Min

      static IndexSetting spatial_Cartesian_3D_Min()
      Fine tune behaviour for spatial values in point index, indexes of type IndexType.POINT.

      Configuration for cartesian coordinate reference system.

      Set min value for envelope in dimension order [minX, minY, minZ].

    • spatial_Cartesian_3D_Max

      static IndexSetting spatial_Cartesian_3D_Max()
      Fine tune behaviour for spatial values in point index, indexes of type IndexType.POINT.

      Configuration for cartesian coordinate reference system.

      Set max value for envelope in dimension order [maxX, maxY, maxZ].

    • spatial_Wgs84_Min

      static IndexSetting spatial_Wgs84_Min()
      Fine tune behaviour for spatial values in point index, indexes of type IndexType.POINT.

      Configuration for cartesian coordinate reference system.

      Set min value for envelope in dimension order [minLongitude, minLatitude].

    • spatial_Wgs84_Max

      static IndexSetting spatial_Wgs84_Max()
      Fine tune behaviour for spatial values in point index, indexes of type IndexType.POINT.

      Configuration for cartesian coordinate reference system.

      Set max value for envelope in dimension order [maxLongitude, maxLatitude].

    • spatial_Wgs84_3D_Min

      static IndexSetting spatial_Wgs84_3D_Min()
      Fine tune behaviour for spatial values in point index, indexes of type IndexType.POINT.

      Configuration for cartesian coordinate reference system.

      Set min value for envelope in dimension order [minLongitude, minLatitude, minZ].

    • spatial_Wgs84_3D_Max

      static IndexSetting spatial_Wgs84_3D_Max()
      Fine tune behaviour for spatial values in point index, indexes of type IndexType.POINT.

      Configuration for cartesian coordinate reference system.

      Set max value for envelope in dimension order [maxLongitude, maxLatitude, maxZ].