Search API

Filter and search through data using pipeline operators.

Example 048 of the basic Soma programs: a small, commented program that teaches one thing. Every output below was printed by soma 3.2.4 when this page was built.

How it is built

The cell SearchAPI has no face and no memory. Handlers: run (line 14).

Generated from soma describe on this file.

The source

048_search_api.cell

// ============================================================================
// 048 — Search API
// ============================================================================
// Filter and search through data using pipeline operators.
//
// Run:   soma run 048_search_api.cell run
// Expect:
//   Search 'alice': [{"name": "Alice", "role": "Engineer"}]
//   Engineers: [{"name": "Alice", "role": "Engineer"}, {"name": "Dave", "role": "Engineer"}]
//   Sorted by name: ["Alice", "Bob", "Carol", "Dave"]

cell SearchAPI {

    on run() {
        let people = list(
            map("name", "Alice", "role", "Engineer", "level", 3),
            map("name", "Bob", "role", "Designer", "level", 2),
            map("name", "Carol", "role", "Manager", "level", 4),
            map("name", "Dave", "role", "Engineer", "level", 2)
        )

        // Search by exact match
        let found = people |> filter_by("name", "=", "Alice") |> select("name", "role")
        print("Search 'alice': {found}")

        // Filter by role
        let engineers = people |> filter_by("role", "=", "Engineer") |> select("name", "role")
        print("Engineers: {engineers}")

        // Sort and pluck names
        let sorted = people |> sort_by("name", "asc") |> pluck("name")
        print("Sorted by name: {sorted}")

        return "done"
    }
}

What the toolchain says

$ soma check 048_search_api.cell
✓ All checks passed.

$ soma run 048_search_api.cell run
Search 'alice': [{"name": "Alice", "role": "Engineer"}]
Engineers: [{"name": "Alice", "role": "Engineer"}, {"name": "Dave", "role": "Engineer"}]
Sorted by name: ["Alice", "Bob", "Carol", "Dave"]
done