使用索引

可以创建和使用Cypher 手册 → 索引中描述的所有索引类型。

本节通过用户数据库示例演示如何使用索引。有关如何在所有具有username属性的User节点上创建索引的信息，请参阅Cypher 手册 → 为节点创建单属性索引。

本示例中使用的源代码位于：EmbeddedNeo4jWithIndexing.java

首先启动数据库服务器

DatabaseManagementService managementService = new DatabaseManagementServiceBuilder( databaseDirectory ).build();
GraphDatabaseService graphDb = managementService.database( DEFAULT_DATABASE_NAME );

然后，您可以配置数据库按名称为用户建立索引。这只需要执行一次。

请注意，在同一事务中不允许进行模式更改和数据更改。每个事务必须更改模式或数据，但不能同时更改两者。

IndexDefinition usernamesIndex;
try ( Transaction tx = graphDb.beginTx() )
{
    Schema schema = tx.schema();
    usernamesIndex = schema.indexFor( Label.label( "User" ) )  (1)
            .on( "username" )                                  (2)
            .withName( "usernames" )                           (3)
            .create();                                         (4)
    tx.commit();                                               (5)
}

1	单属性索引在标签与属性名称的组合上定义。通过指定节点标签开始索引定义。
2	接下来，定义应包含在此索引中的属性。为所有具有`User`标签且还具有`username`属性的节点建立索引。这样，您可以通过其`username`属性查找`User`节点。
3	索引始终具有名称。如果未指定，则将为您生成。
4	调用`create`对于在数据库中创建索引定义是必要的。此索引现在已创建，但它仍然仅存在于您当前的事务中。
5	提交事务会将新索引提交到数据库。一旦它完成使用数据库中现有数据填充自身，它将可供使用。

索引在首次创建时会异步填充。可以使用核心 API 等待索引填充完成

try ( Transaction tx = graphDb.beginTx() )
{
    Schema schema = tx.schema();
    schema.awaitIndexOnline( usernamesIndex, 10, TimeUnit.SECONDS );
}

还可以查询索引填充的进度

try ( Transaction tx = graphDb.beginTx() )
{
    Schema schema = tx.schema();
    System.out.println( String.format( "Percent complete: %1.0f%%",
        schema.getIndexPopulationProgress( usernamesIndex ).getCompletedPercentage() ) );
}

现在您可以添加用户了

try ( Transaction tx = graphDb.beginTx() )
{
    Label label = Label.label( "User" );

    // Create some users
    for ( int id = 0; id < 100; id++ )
    {
        Node userNode = tx.createNode( label );
        userNode.setProperty( "username", "user" + id + "@neo4j.org" );
    }
    System.out.println( "Users created" );
    tx.commit();
}

有关如何正确关闭从索引查找返回的ResourceIterators的信息，请阅读资源迭代器。

这就是如何通过 ID 查找用户的方法

Label label = Label.label( "User" );
int idToFind = 45;
String nameToFind = "user" + idToFind + "@neo4j.org";
try ( Transaction tx = graphDb.beginTx() )
{
    try ( ResourceIterator<Node> users =
                  tx.findNodes( label, "username", nameToFind ) )
    {
        ArrayList<Node> userNodes = new ArrayList<>();
        while ( users.hasNext() )
        {
            userNodes.add( users.next() );
        }

        for ( Node node : userNodes )
        {
            System.out.println(
                    "The username of user " + idToFind + " is " + node.getProperty( "username" ) );
        }
    }
}

更新用户姓名时，索引也会更新

try ( Transaction tx = graphDb.beginTx() )
{
    Label label = Label.label( "User" );
    int idToFind = 45;
    String nameToFind = "user" + idToFind + "@neo4j.org";

    for ( Node node : loop( tx.findNodes( label, "username", nameToFind ) ) )
    {
        node.setProperty( "username", "user" + (idToFind + 1) + "@neo4j.org" );
    }
    tx.commit();
}

删除用户时，它会自动从索引中删除

try ( Transaction tx = graphDb.beginTx() )
{
    Label label = Label.label( "User" );
    int idToFind = 46;
    String nameToFind = "user" + idToFind + "@neo4j.org";

    for ( Node node : loop( tx.findNodes( label, "username", nameToFind ) ) )
    {
        node.delete();
    }
    tx.commit();
}

如果您更改数据模型，也可以删除索引

try ( Transaction tx = graphDb.beginTx() )
{
    IndexDefinition usernamesIndex = tx.schema().getIndexByName( "usernames" ); (1)
    usernamesIndex.drop();
    tx.commit();
}

1	您可以通过创建时指定的索引名称查找索引。索引名称保证是唯一的，以确保您不会错误地查找和删除错误的索引。