The Neo4j Manual > Reference > REST API > Indexes
Prev   Next

18.7. Indexes

18.7.1. Create node index
18.7.2. Create node index with configuration
18.7.3. Delete node index
18.7.4. List node indexes
18.7.5. Add node to index
18.7.6. Remove all entries with a given node from an index
18.7.7. Remove all entries with a given node and key from an index
18.7.8. Remove all entries with a given node, key and value from an index
18.7.9. Find node by exact match
18.7.10. Find node by query

An index can contain either nodes or relationships.

[Note]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.7.2, “Create node index with configuration”.

18.7.1. Create node index

[Note]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.38. Final Graph

Final-Graph-Create-node-index.svg

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.7.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.39. Final Graph

Final-Graph-Create-node-index-with-configuration.svg

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}",
  "provider" : "lucene",
  "type" : "fulltext"
}

18.7.3. Delete node index

Figure 18.40. Final Graph

Final-Graph-Delete-node-index.svg

Example request

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

Example response

  • 204: No Content 
18.7.4. List node indexes
Figure 18.41. Final Graph

Final-Graph-List-node-indexes.svg


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.7.5. Add node to index
Associates a node with the given key/value pair in the given index.
[Note]Note
Spaces in the URI have to be escaped.
[Caution]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.42. Final Graph

Final-Graph-Add-node-to-index.svg


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/104",
  "key" : "some-key"
}
Example response
  • 
201: Created

  • 
Content-Type: application/json

  • 
Location: http://localhost:7474/db/data/index/node/favorites/some-key/some%20value/104

{
  "indexed" : "http://localhost:7474/db/data/index/node/favorites/some-key/some%20value/104",
  "outgoing_relationships" : "http://localhost:7474/db/data/node/104/relationships/out",
  "data" : {
  },
  "traverse" : "http://localhost:7474/db/data/node/104/traverse/{returnType}",
  "all_typed_relationships" : "http://localhost:7474/db/data/node/104/relationships/all/{-list|&|types}",
  "property" : "http://localhost:7474/db/data/node/104/properties/{key}",
  "self" : "http://localhost:7474/db/data/node/104",
  "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/104/relationships/out/{-list|&|types}",
  "properties" : "http://localhost:7474/db/data/node/104/properties",
  "incoming_relationships" : "http://localhost:7474/db/data/node/104/relationships/in",
  "extensions" : {
  },
  "create_relationship" : "http://localhost:7474/db/data/node/104/relationships",
  "paged_traverse" : "http://localhost:7474/db/data/node/104/paged/traverse/{returnType}{?pageSize,leaseTime}",
  "all_relationships" : "http://localhost:7474/db/data/node/104/relationships/all",
  "incoming_typed_relationships" : "http://localhost:7474/db/data/node/104/relationships/in/{-list|&|types}"
}
18.7.6. Remove all entries with a given node from an index
Figure 18.43. Final Graph

Final-Graph-Remove-all-entries-with-a-given-node-from-an-index.svg


Example request
  • 
DELETE  http://localhost:7474/db/data/index/node/kvnode/111

  • 
Accept: application/json

Example response
  • 
204: No Content

18.7.7. Remove all entries with a given node and key from an index
Figure 18.44. Final Graph

Final-Graph-Remove-all-entries-with-a-given-node-and-key-from-an-index.svg


Example request
  • 
DELETE  http://localhost:7474/db/data/index/node/kvnode/kvkey2/112

  • 
Accept: application/json

Example response
  • 
204: No Content

18.7.8. Remove all entries with a given node, key and value from an index
Figure 18.45. Final Graph

Final-Graph-Remove-all-entries-with-a-given-node,-key-and-value-from-an-index.svg


Example request
  • 
DELETE  http://localhost:7474/db/data/index/node/kvnode/kvkey1/value1/113

  • 
Accept: application/json

Example response
  • 
204: No Content

18.7.9. Find node by exact match
[Note]Note
Spaces in the URI have to be escaped.
Figure 18.46. Final Graph

Final-Graph-Find-node-by-exact-match.svg


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/105",
  "outgoing_relationships" : "http://localhost:7474/db/data/node/105/relationships/out",
  "data" : {
  },
  "traverse" : "http://localhost:7474/db/data/node/105/traverse/{returnType}",
  "all_typed_relationships" : "http://localhost:7474/db/data/node/105/relationships/all/{-list|&|types}",
  "property" : "http://localhost:7474/db/data/node/105/properties/{key}",
  "self" : "http://localhost:7474/db/data/node/105",
  "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/105/relationships/out/{-list|&|types}",
  "properties" : "http://localhost:7474/db/data/node/105/properties",
  "incoming_relationships" : "http://localhost:7474/db/data/node/105/relationships/in",
  "extensions" : {
  },
  "create_relationship" : "http://localhost:7474/db/data/node/105/relationships",
  "paged_traverse" : "http://localhost:7474/db/data/node/105/paged/traverse/{returnType}{?pageSize,leaseTime}",
  "all_relationships" : "http://localhost:7474/db/data/node/105/relationships/all",
  "incoming_typed_relationships" : "http://localhost:7474/db/data/node/105/relationships/in/{-list|&|types}"
} ]
18.7.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
Figure 18.47. Final Graph

Final-Graph-Find-node-by-query.svg


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/106/relationships/out",
  "data" : {
    "Name" : "Builder"
  },
  "traverse" : "http://localhost:7474/db/data/node/106/traverse/{returnType}",
  "all_typed_relationships" : "http://localhost:7474/db/data/node/106/relationships/all/{-list|&|types}",
  "property" : "http://localhost:7474/db/data/node/106/properties/{key}",
  "self" : "http://localhost:7474/db/data/node/106",
  "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/106/relationships/out/{-list|&|types}",
  "properties" : "http://localhost:7474/db/data/node/106/properties",
  "incoming_relationships" : "http://localhost:7474/db/data/node/106/relationships/in",
  "extensions" : {
  },
  "create_relationship" : "http://localhost:7474/db/data/node/106/relationships",
  "paged_traverse" : "http://localhost:7474/db/data/node/106/paged/traverse/{returnType}{?pageSize,leaseTime}",
  "all_relationships" : "http://localhost:7474/db/data/node/106/relationships/all",
  "incoming_typed_relationships" : "http://localhost:7474/db/data/node/106/relationships/in/{-list|&|types}"
} ]
Copyright © 2012 Neo Technology
Prev Up Next
 Home