Python Developer Guide
Other documentationsDemoCommunityGitHub
  • Forest Admin
  • Getting started
    • How it works
    • Quick start
      • Flask
      • Django
    • Create your agent
    • Troubleshooting
    • Migrating legacy agents
      • Pre-requisites
      • Recommendations
      • Migration steps
      • Code transformations
        • API Charts
        • Live Queries
        • Smart Charts
        • Route overrides
        • Smart Actions
        • Smart Fields
        • Smart Relationships
        • Smart Segments
  • Data Sources
    • Getting Started
      • Collection selection
      • Naming conflicts
      • Query interface and Native Queries
        • Fields and projections
        • Filters
        • Aggregations
    • Provided data sources
      • SQLAlchemy
      • Django
        • Polymorphic relationships
    • Write your own
      • Translation strategy
        • Structure declaration
        • Capabilities declaration
        • Read implementation
        • Write implementation
        • Intra-data source Relationships
      • Contribute
  • Agent customization
    • Getting Started
    • Actions
      • Scope and context
      • Result builder
      • Static Forms
      • Widgets in Forms
      • Dynamic Forms
      • Form layout customization
      • Related data invalidation
    • Charts
      • Value
      • Objective
      • Percentage
      • Distribution
      • Leaderboard
      • Time-based
    • Fields
      • Add fields
      • Move, rename and remove fields
      • Override binary field mode
      • Override writing behavior
      • Override filtering behavior
      • Override sorting behavior
      • Validation
    • Hooks
      • Collection hook
      • Collection override
    • Pagination
    • Plugins
      • Write your own
    • Relationships
      • To a single record
      • To multiple records
      • Computed foreign keys
      • Under the hood
    • Search
    • Segments
  • Frontend customization
    • Smart Charts
      • Create a table chart
      • Create a bar chart
      • Create a cohort chart
      • Create a density map
    • Smart Views
      • Create a Map view
      • Create a Calendar view
      • Create a Shipping view
      • Create a Gallery view
      • Create a custom tinder-like validation view
      • Create a custom moderation view
  • Deploying to production
    • Environments
      • Deploy on AWS
      • Deploy on Heroku
      • Deploy on GCP
      • Deploy on Ubuntu
    • Development workflow
    • Using branches
    • Deploying your changes
    • Forest Admin CLI commands
      • init
      • login
      • branch
      • switch
      • set-origin
      • push
      • environments:create
      • environments:reset
      • deploy
  • Under the hood
    • .forestadmin-schema.json
    • Data Model
      • Typing
      • Relationships
    • Security & Privacy
Powered by GitBook
On this page
  • Structure
  • Migrating
  • Relationships when the foreign key is accessible
  • Relationships when you need complex logic to get a foreign key

Was this helpful?

  1. Getting started
  2. Migrating legacy agents
  3. Code transformations

Smart Relationships

PreviousSmart FieldsNextSmart Segments

Last updated 1 year ago

Was this helpful?

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

Smart relationships are very different between the two versions of the Agent.

You can find the full documentation of relationship customization .

Structure

Smart relationships on legacy agents were declared creating a smart field with a reference property but differed in the way that:

  • Relationships to a single record (many-to-one or one-to-one) worked using the get function which needed to return a single record.

  • Relationships to a list of records (one-to-many or many-to-many) worked by implementing all the CRUD routes on a router file.

The new system is completely different: it is based on primary keys and foreign keys.

Migrating

Relationships when the foreign key is accessible

from app.models import Address
from django_forest.utils.collection import Collection

# Many to one relationships
class OrderForest(Collection):
    def load(self):
        self.fields = [
            {
                "field": "delivery_address",
                "type": "String",
                "reference": "Address.id",
                "get": self.get_delivery_address,
            }
        ]

    def get_delivery_address(self, obj):
        return obj.delivery_address

# Reverse relationship
class AddressForest(Collection):
    def load(self):
        self.fields = [
            {
                "field": "orders",
                "type": ["String"],
                "reference": "Order.id",
            }
        ]

# urls.py
from app.views import AddressOrders

urlpatterns = [
    path(
        '/forest/address/<pk>/relationships/orders',
        AddressOrdersView.as_view(),
        name='address_orders'
    ),
    # ...
]

# views.py
from django.http import JsonResponse
from django.views import generic
from django_forest.resources.utils.queryset import PaginationMixin
from django_forest.utils.schema.json_api_schema import JsonApiSchema

from app.models import Order

class AddressOrdersView(PaginationMixin, generic.ListView):
    def get(self, request, pk, *args, **kwargs):
        params = request.GET.dict()
        queryset = Orders.objects.filter(delivery_address_id=pk)

        # pagination
        queryset = self.get_pagination(params, queryset)

        # json api serializer
        Schema = JsonApiSchema.get('orders')
        data = Schema().dump(queryset, many=True)

        return JsonResponse(data, safe=False)
# Create the relationship
agent.customize_collection("order").add_many_to_one_relation(
    "delivery_address", "Address", "delivery_address_id"
)

# Create the reverse relationship
agent.customize_collection("Address").add_one_to_many_relation(
    "orders", "Order", "delivery_address_id"
)

Relationships when you need complex logic to get a foreign key

In this example, we want to create a relationship between the order collection and the address collection (assuming that it does not already exist in the database because depends on complex logic).

We can see that in the legacy agent, the delivery_address field was a smart field that returned the full address of the order, while in the new agent, we will create a computed field that will contain the address ID (the foreign key), and then create the relationship.

We won't be detailing the migration of a relation to a list of records here, but it is very similar to the one described below.

This will be much faster and will not require In filter operators to be implemented (as unlike computed fields, imported fields are natively filterable and sortable).

from app.models import Address
from django_forest.utils.collection import Collection

# Many to one relationships
class OrderForest(Collection):
    def load(self):
        self.fields = [
            {
                "field": "delivery_address",
                "type": "String",
                "reference": "Address.id",
                "get": self.get_delivery_address,
            }
        ]

    def get_delivery_address(self, obj):
        return Address.objects.filter( """complex_query""" )
from typing import List, Dict

from app.models import Address
from forestadmin.datasource_toolkit.context.collection_context import CollectionCustomizationContext
from forestadmin.datasource_toolkit.interfaces.records import RecordsDataAlias

def get_delivery_address_id(
    records: List[RecordsDataAlias], context: CollectionCustomizationContext
):
    addresses_by_order_id = Address.objects.filter("""complex_query_here""")
    return [addresses_by_order_id[order["id"]]["id"] for order in records]

# Create a computed field that will contain the address ID (the foreign key)
agent.customize_collection("order").add_field("delivery_address_id", {
    "column_type": "Number",
    "dependencies": ["id"],
    "get_values": get_delivery_address_id
}).replace_field_operator(
    # Make the field filterable (this is required for the relationship to work)
    "delivery_address_id", "in",
    lambda value, context: pass  # implement the reverse-lookup logic here
).add_many_to_one_relation(
    # Create the relationship
    "delivery_address", "Address", "delivery_address_id"
)

If the foreign key was already present in the database in a related table, use the feature to move it to the correct collection instead of using a computed field.

here
import-rename-delete