Search

This is the official documentation of the forestadmin-agent-django and forestadmin-agent-flask Python agents.

In Forest Admin, pages that show lists of records have a free-text search bar on top of them.

A search bar on the main Table View

Search modes

2 search modes are supported: "normal" and "extended".

• All searches start by being a "normal" search.

• If the records users are looking for are not found, it is possible to trigger an "extended" search from the footer.

Extended search call to action

Default behavior

Natively, the search behavior is to seek value occurrences within columns of the Collection (in normal mode), and columns of the Collections of direct relations (in extended mode).

By default, Forest Admin will search only in specific columns, depending on their type:

Column Type	Default search behavior
Enum	Column is equal to the search string (case-insensitive).
Number	Column is equal to the search string (if the search string is numeric).
String	Column contains the search string (case-insensitive).
Uuid	Column is equal to the search string.
Other types	Column is ignored by the default search handler.

Customization

If you want to make a column searchable, you must define the right operator to allow the search to be performed. Please refer to the Operators to support table to know which operator to define.

Alternatively, you may want to change how the search behaves in your admin panel.

For instance:

• search only on the columns that are relevant to your use case.

• use full-text indexes (i.e. Postgres tsquery and tsvector, Algolia, Elastic search, ...)

To customize the search behavior, you must define a handler that returns a ConditionTree.

Making the search case-sensitive by default

In this example, we use the searchExtended condition to toggle between case-sensitive and insensitive searches.

from forestadmin.datasource_toolkit.context.collection_context import CollectionCustomizationContext
from forestadmin.datasource_toolkit.interfaces.query.condition_tree.nodes.base import ConditionTree
from forestadmin.datasource_toolkit.interfaces.query.condition_tree.nodes.branch import ConditionTreeBranch
from forestadmin.datasource_toolkit.interfaces.query.condition_tree.nodes.leaf import ConditionTreeLeaf

def search_in_people(
    search_string, extended_search: bool, context: CollectionCustomizationContext
) -> ConditionTree:
    return ConditionTreeBranch(
        "or",
        [
            ConditionTreeLeaf("firstName", "contains", search_string),
            ConditionTreeLeaf("lastName", "contains", search_string),
        ],
    )

agent.customize_collection("people").replace_search(search_in_people)

Changing searched columns

import re
from forestadmin.datasource_toolkit.context.collection_context import CollectionCustomizationContext
from forestadmin.datasource_toolkit.interfaces.query.condition_tree.nodes.base import ConditionTree
from forestadmin.datasource_toolkit.interfaces.query.condition_tree.nodes.branch import ConditionTreeBranch
from forestadmin.datasource_toolkit.interfaces.query.condition_tree.nodes.leaf import ConditionTreeLeaf

product_reference_regexp = r"^[a-f]{16}$"
barcode_regexp = r"^[0-9]{10}$"

async def search_in_products(
    search_string, extended_search: bool, context: CollectionCustomizationContext
) -> ConditionTree:
    # User is searching using a product reference.
    if re.match(product_reference_regexp, search_string):
        return ConditionTreeLeaf("reference", "equal", search_string)

    # User is search a barcode
    if re.match(barcode_regexp, search_string):
        return ConditionTreeLeaf("barCode", "equal", int(search_string))

    # User is searching something else, let's search in the product name only
    if not extended_search:
        return ConditionTreeLeaf("name", "contains", search_string)

    # In "extended" mode, we search on name, description and brand name
    return ConditionTreeBranch(
        "or",
        [
            ConditionTreeLeaf("name", "contains", search_string),
            ConditionTreeLeaf("description", "contains", search_string),
            ConditionTreeLeaf("brand:name", "equal", search_string),
        ],
    )

agent.customize_collection("products").replace_search(search_in_products)

Calling an external API

If your data is indexed using a SaaS, an external store, or a full-text index, you can call it in the search handler.

from forestadmin.datasource_toolkit.context.collection_context import CollectionCustomizationContext
from forestadmin.datasource_toolkit.interfaces.query.condition_tree.nodes.base import ConditionTree
from forestadmin.datasource_toolkit.interfaces.query.condition_tree.nodes.leaf import ConditionTreeLeaf
from algoliasearch.search_client import SearchClient

client = SearchClient.create("YourApplicationID", "YourWriteAPIKey")
index = client.init_index("test_index")

async def search_in_products(
    search_string, extended_search: bool, context: CollectionCustomizationContext
) -> ConditionTree:
    hits = index.search(
        search_string,
        {"attributesToRetrieve": ["id"], "hitsPerPage": 50},
    )
    return ConditionTreeLeaf("id", "in", [hit["id"] for hit in hits])

agent.customize_collection("products").replace_search(search_in_products)

Disable the search

By default, the search bar is displayed when at least one field supports the operator used for search based on its type (see this table).

You can remove the search bar by disabling the search on a collection:

agent.customize_collection("product").disable_search()