search-queries.md

Search Queries

In addition to structured queries, persist also supports fuzzy search across fields indexed for search.

Indexing Data for Search

To set index properties on a model for search, define the static function searchProperties as an arrow function that returns an array of fields that should be indexed for search.

Let's consider the following models:

import Persist from "@acodeninja/persist";

export class Person extends Persist.Type.Model {
    static {
        this.name = Persist.Type.String.required;
        this.address = () => Address;
        this.searchProperties = () => ['name', 'address.address'];
    }
}

export class Address extends Persist.Type.Model {
    static {
        this.address = Persist.Type.String.required;
        this.postcode = Persist.Type.String.required;
        this.searchProperties = () => ['address', 'postcode'];
    }
}

Every time a Person model is put to a storage engine, the person's name and address are saved to the search index and can be queried.

Searching

To search for any Person who lives on station road, the following search query can be run:

import Persist from "@acodeninja/persist";
import Person from "./Person";
import FileEngine from "@acodeninja/persist/engine/file"

FileEngine
    .configure(configuration)
    .search(Person, 'station road');

This will find all matches for people who live at any address that includes station road.