Prev |  | Next

## 18.9. Indexes

An index can contain either nodes or relationships.

| Note
To create an index with default configuration, simply start using it by adding nodes/relationships to it. It will then be automatically created for you.

What default configuration means depends on how you have configured your database. If you haven’t changed any indexing configuration, it means the indexes will be using a Lucene-based backend.

All the examples below show you how to do operations on node indexes, but all of them are just as applicable to relationship indexes. Simple change the "node" part of the URL to "relationship".

If you want to customize the index settings, see Section 18.9.2, “Create node index with configuration”.

### 18.9.1. Create node index

| Note
Instead of creating the index this way, you can simply start to use it, and it will be created automatically with default configuration.

Figure 18.47. Final Graph

Example request

- `POST` `http://localhost:7474/db/data/index/node/`
- `Accept:` `application/json`
- `Content-Type:` `application/json`

    {
      "name" : "favorites"
    }

Example response

- `201:` `Created`
- `Content-Type:` `application/json`
- `Location:` `http://localhost:7474/db/data/index/node/favorites/`

    {
      "template" : "http://localhost:7474/db/data/index/node/favorites/{key}/{value}"
    }

### 18.9.2. Create node index with configuration

This request is only necessary if you want to customize the index settings. If you are happy with the defaults, you can just start indexing nodes/relationships, as non-existent indexes will automatically be created as you do. See Section 14.10, “Configuration and fulltext indexes” for more information on index configuration.

Figure 18.48. Final Graph

Example request

- `POST` `http://localhost:7474/db/data/index/node/`
- `Accept:` `application/json`
- `Content-Type:` `application/json`

    {
      "name" : "fulltext",
      "config" : {
        "type" : "fulltext",
        "provider" : "lucene"
      }
    }

Example response

- `201:` `Created`
- `Content-Type:` `application/json`
- `Location:` `http://localhost:7474/db/data/index/node/fulltext/`

    {
      "template" : "http://localhost:7474/db/data/index/node/fulltext/{key}/{value}",
      "type" : "fulltext",
      "provider" : "lucene"
    }

### 18.9.3. Delete node index

Figure 18.49. Final Graph

Example request

- `DELETE` `http://localhost:7474/db/data/index/node/kvnode`
- `Accept:` `application/json`

Example response

- `204:` `No Content`

### 18.9.4. List node indexes

Figure 18.50. Final Graph

Example request

- `GET` `http://localhost:7474/db/data/index/node/`
- `Accept:` `application/json`

Example response

- `200:` `OK`
- `Content-Type:` `application/json`

    {
      "favorites" : {
        "template" : "http://localhost:7474/db/data/index/node/favorites/{key}/{value}",
        "provider" : "lucene",
        "type" : "exact"
      }
    }

### 18.9.5. Add node to index

Associates a node with the given key/value pair in the given index.

| Note
Spaces in the URI have to be encoded as `%20`.

| Caution
This does not overwrite previous entries. If you index the same key/value/item combination twice, two index entries are created. To do update-type operations, you need to delete the old entry before adding a new one.

Figure 18.51. Final Graph

Example request

- `POST` `http://localhost:7474/db/data/index/node/favorites`
- `Accept:` `application/json`
- `Content-Type:` `application/json`

    {
      "value" : "some value",
      "uri" : "http://localhost:7474/db/data/node/1",
      "key" : "some-key"
    }

Example response

- `201:` `Created`
- `Content-Type:` `application/json`
- `Location:` `http://localhost:7474/db/data/index/node/favorites/some-key/some%20value/1`

    {
      "extensions" : {
      },
      "paged_traverse" : "http://localhost:7474/db/data/node/1/paged/traverse/{returnType}{?pageSize,leaseTime}",
      "outgoing_relationships" : "http://localhost:7474/db/data/node/1/relationships/out",
      "traverse" : "http://localhost:7474/db/data/node/1/traverse/{returnType}",
      "all_typed_relationships" : "http://localhost:7474/db/data/node/1/relationships/all/{-list|&|types}",
      "property" : "http://localhost:7474/db/data/node/1/properties/{key}",
      "all_relationships" : "http://localhost:7474/db/data/node/1/relationships/all",
      "self" : "http://localhost:7474/db/data/node/1",
      "properties" : "http://localhost:7474/db/data/node/1/properties",
      "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/1/relationships/out/{-list|&|types}",
      "incoming_relationships" : "http://localhost:7474/db/data/node/1/relationships/in",
      "incoming_typed_relationships" : "http://localhost:7474/db/data/node/1/relationships/in/{-list|&|types}",
      "create_relationship" : "http://localhost:7474/db/data/node/1/relationships",
      "data" : {
      },
      "indexed" : "http://localhost:7474/db/data/index/node/favorites/some-key/some%20value/1"
    }

### 18.9.6. Remove all entries with a given node from an index

Figure 18.52. Final Graph

Example request

- `DELETE` `http://localhost:7474/db/data/index/node/kvnode/11`
- `Accept:` `application/json`

Example response

- `204:` `No Content`

### 18.9.7. Remove all entries with a given node and key from an index

Figure 18.53. Final Graph

Example request

- `DELETE` `http://localhost:7474/db/data/index/node/kvnode/kvkey2/12`
- `Accept:` `application/json`

Example response

- `204:` `No Content`

### 18.9.8. Remove all entries with a given node, key and value from an index

Figure 18.54. Final Graph

Example request

- `DELETE` `http://localhost:7474/db/data/index/node/kvnode/kvkey1/value1/13`
- `Accept:` `application/json`

Example response

- `204:` `No Content`

### 18.9.9. Find node by exact match

| Note
Spaces in the URI have to be encoded as `%20`.

Figure 18.55. Final Graph

Example request

- `GET` `http://localhost:7474/db/data/index/node/favorites/key/the%2520value`
- `Accept:` `application/json`

Example response

- `200:` `OK`
- `Content-Type:` `application/json`

    [ {
      "indexed" : "http://localhost:7474/db/data/index/node/favorites/key/the%2520value/2",
      "outgoing_relationships" : "http://localhost:7474/db/data/node/2/relationships/out",
      "data" : {
      },
      "traverse" : "http://localhost:7474/db/data/node/2/traverse/{returnType}",
      "all_typed_relationships" : "http://localhost:7474/db/data/node/2/relationships/all/{-list|&|types}",
      "property" : "http://localhost:7474/db/data/node/2/properties/{key}",
      "self" : "http://localhost:7474/db/data/node/2",
      "properties" : "http://localhost:7474/db/data/node/2/properties",
      "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/2/relationships/out/{-list|&|types}",
      "incoming_relationships" : "http://localhost:7474/db/data/node/2/relationships/in",
      "extensions" : {
      },
      "create_relationship" : "http://localhost:7474/db/data/node/2/relationships",
      "paged_traverse" : "http://localhost:7474/db/data/node/2/paged/traverse/{returnType}{?pageSize,leaseTime}",
      "all_relationships" : "http://localhost:7474/db/data/node/2/relationships/all",
      "incoming_typed_relationships" : "http://localhost:7474/db/data/node/2/relationships/in/{-list|&|types}"
    } ]

### 18.9.10. Find node by query

The query language used here depends on what type of index you are querying. The default index type is Lucene, in which case you should use the Lucene query language here. Below an example of a fuzzy search over multiple keys.

See: http://lucene.apache.org/java/3_5_0/queryparsersyntax.html

Getting the results with a predefined ordering requires adding the parameter

order=ordering

where ordering is one of index, relevance or score. In this case an additional field will be added to each result, named score, that holds the float value that is the score reported by the query result.

Figure 18.56. Final Graph

Example request

- `GET` `http://localhost:7474/db/data/index/node/bobTheIndex?query=Name:Build~0.1%20AND%20Gender:Male`
- `Accept:` `application/json`

Example response

- `200:` `OK`
- `Content-Type:` `application/json`

    [ {
      "outgoing_relationships" : "http://localhost:7474/db/data/node/3/relationships/out",
      "data" : {
        "Name" : "Builder"
      },
      "traverse" : "http://localhost:7474/db/data/node/3/traverse/{returnType}",
      "all_typed_relationships" : "http://localhost:7474/db/data/node/3/relationships/all/{-list|&|types}",
      "property" : "http://localhost:7474/db/data/node/3/properties/{key}",
      "self" : "http://localhost:7474/db/data/node/3",
      "properties" : "http://localhost:7474/db/data/node/3/properties",
      "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/3/relationships/out/{-list|&|types}",
      "incoming_relationships" : "http://localhost:7474/db/data/node/3/relationships/in",
      "extensions" : {
      },
      "create_relationship" : "http://localhost:7474/db/data/node/3/relationships",
      "paged_traverse" : "http://localhost:7474/db/data/node/3/paged/traverse/{returnType}{?pageSize,leaseTime}",
      "all_relationships" : "http://localhost:7474/db/data/node/3/relationships/all",
      "incoming_typed_relationships" : "http://localhost:7474/db/data/node/3/relationships/in/{-list|&|types}"
    } ]

Copyright © 2013 Neo Technology

Prev | Up | Next
| Home |