Smart Segments

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

Smart Segments should be quick to migrate, as the syntax is very similar to the legacy agent.

You can find the full documentation of segment customization here.

How to migrate

Structure

Because the new Forest Admin agent is designed to work with multiple databases, the return value of the filter function is not a Sequelize or Mongoose condition anymore.

Instead, you'll be building a condition tree that will be translated to the appropriate database syntax by the agent.

Performance

All queries cannot be expressed in the Forest Admin query interface, but many can.

You can have great performance improvements by using the Forest Admin query interface to build your conditions, instead of performing the query yourself, and then building a naive condition tree, which filters by primary key like in the example we're providing.

Example

In this example, we migrate a segment that returns the 5 bestsellers of a product collection.

Before

from app.models import Product
from django.db.models import Q
from django_forest.utils.collection import Collection

class ProductsForest(Collection):
    def load(self):
        self.segments = [
            {
                "name": "best_sellers",
                "where": self.get_best_sellers
            }
        ]

    def get_best_sellers(self):
        products = Product.objects.raw("""
            SELECT products.id, COUNT(orders.*)
            FROM products
            JOIN orders ON orders.product_id = products.id
            GROUP BY products.id
            ORDER BY count DESC
            LIMIT 5;"""
        )
        return Q(id__in=[p.id for p in products])

After

from app.models import Product
from forestadmin.datasource_toolkit.context.collection_context import CollectionCustomizationContext

def best_sellers_segment_handler(context: CollectionCustomizationContext)
    products = Product.objects.raw("""
        SELECT products.id, COUNT(orders.*)
        FROM products
        JOIN orders ON orders.product_id = products.id
        GROUP BY products.id
        ORDER BY count DESC
        LIMIT 5;"""
    )
    return ConditionTreeLeaf("id", "in", [p.id for p in products])

agent.customize_collection("Products").add_segment(
    "best_sellers", best_seller_segment_handler
)