Skip to content

document array indexing #151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
swilly22 wants to merge 5 commits into from
Closed

document array indexing #151

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4c0d52c
document array indexing
swilly22 Apr 23, 2025
285e7de
Update indexing.md
swilly22 Apr 24, 2025
e321393
Update indexing.md
swilly22 Apr 24, 2025
dab23a1
Update indexing.md
swilly22 Apr 24, 2025
96de7c3
Update indexing.md
swilly22 Apr 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions cypher/indexing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@
title: "Indexing"
nav_order: 21
description: >
FalkorDB supports single-property indexes for node labels and for relationship type. String, numeric, and geospatial data types can be indexed.
FalkorDB supports single-property indexes for node labels and for relationship type.
String, boolean, numeric, geospatial and array data types can be indexed.
parent: "Cypher Language"
---

# Indexing

FalkorDB supports single-property indexes for node labels and for relationship type. String, numeric, and geospatial data types can be indexed.
FalkorDB now supports single-property indexes for node labels and relationship types. It can index various data types, including string, boolean, numeric, geospatial data, and array.

## Creating an index for a node label

Expand Down Expand Up @@ -49,6 +50,28 @@ GRAPH.QUERY DEMO_GRAPH

Geospatial indexes can currently only be leveraged with `<` and `<=` filters; matching nodes outside of the given radius is performed using conventional matching.

### Array values
FalkorDB can index arrays, this allows for a quick lookup of individual array elements.
For example, to find Student nodes with a grade of 92 in their `score_card` array attribute.

```
// Index Student score_card
GRAPH.QUERY DEMO_GRAPH "CREATE INDEX FOR (s:Student) ON (s.score_card)"

// Introduce a few Student nodes
GRAPH.QUERY DEMO_GRAPH "CREATE (:Student {score_card:[83, 62, 91, 87]}), (:Student {score_card:[73, 89, 75, 96]})"

// Look up students with a score of 91 on their score card
GRAPH.QUERY DEMO_GRAPH "MATCH (s:Student) WHERE 91 IN s.score_card RETURN s"
```

Using the `IN` predicate we can specify the element we're searching for in the
entities array attribute. Please note that the array can contain a mixture of different data types
e.g.: `CREATE (:Student {score_card:[true, 'str', 91, -2.1, point({latitude: 30, longitude: 32})]})`

At the moment, only string, boolean, and numeric elements are indexed; any other data type
will not be able to utilize the index and will cause FalkorDB to fall back to a non-index scan.

## Creating an index for a relationship type

For a relationship type, the index creation syntax is:
Expand Down