DOCSP-46325: Models

snooty.toml

@@ -5,11 +5,14 @@ intersphinx = [ "https://www.mongodb.com/docs/manual/objects.inv",
                 "https://www.mongodb.com/docs/atlas/objects.inv"
               ]
 
-# toc_landing_pages = ["/paths/to/pages/that/have/nested/content"]
+toc_landing_pages = [
+    "/model-data"
+]
 
 [constants]
 django-odm = "Django MongoDB Backend"
 api = "https://django-mongodb.readthedocs.io/en/latest/"
 mdb-server = "MongoDB Server"
 django-version = "5.0"
 django-docs = "https://docs.djangoproject.com/en/{+django-version+}"
+framework = "Django"

source/includes/model-data/models.py

@@ -0,0 +1,85 @@
+# start-models
+from django.db import models
+
+class Movie(models.Model):
+    title = models.CharField(max_length=200)
+    plot = models.TextField(blank=True)
+    runtime = models.IntegerField(default=0)
+    released = models.DateTimeField("release date", null=True, blank=True)
+
+    class Meta:
+        db_table = "movies"
+        managed = False
+
+    def __str__(self):
+        return self.title
+# end-models
+
+# start-json-field
+from django.db import models
+
+class Movie(models.Model):
+    title = models.CharField(max_length=200)
+    plot = models.TextField(blank=True)
+    runtime = models.IntegerField(default=0)
+    released = models.DateTimeField("release date", null=True, blank=True)
+    imdb = models.JSONField(null=True, blank=True)
+
+    class Meta:
+        db_table = "movies"
+        managed = False
+
+    def __str__(self):
+        return self.title
+# end-json-field
+
+# start-array-field
+from django.db import models
+from django_mongodb_backend.fields import ArrayField
+
+class Movie(models.Model):
+    title = models.CharField(max_length=200)
+    plot = models.TextField(blank=True)
+    runtime = models.IntegerField(default=0)
+    released = models.DateTimeField("release date", null=True, blank=True)
+    genres = ArrayField(
+             models.CharField(max_length=100),
+             size=5,
+             null=True,
+             blank=True)
+
+    class Meta:
+        db_table = "movies"
+        managed = False
+
+    def __str__(self):
+        return self.title
+# end-array-field
+
+# start-embedded-field
+from django.db import models
+from django_mongodb_backend.models import EmbeddedModel
+from django_mongodb_backend.fields import EmbeddedModelField
+
+class Award(EmbeddedModel):
+    wins = models.IntegerField(default=0)
+    nominations = models.IntegerField(default=0)
+    text = models.CharField(max_length=100)
+
+    class Meta:
+        managed = False
+
+class Movie(models.Model):
+    title = models.CharField(max_length=200)
+    plot = models.TextField(blank=True)
+    runtime = models.IntegerField(default=0)
+    released = models.DateTimeField("release date", null=True, blank=True)
+    awards = EmbeddedModelField(Award, null=True, blank=True)
+
+    class Meta:
+        db_table = "movies"
+        managed = False
+
+    def __str__(self):
+        return self.title
+# end-embedded-field

source/index.txt

@@ -11,6 +11,7 @@ Django MongoDB Backend
 
 .. toctree::
 
+    Model Your Data </model-data>
     Issues & Help </issues-and-help>
     Compatibility </compatibility>
 
@@ -19,7 +20,6 @@ Django MongoDB Backend
    Get Started </get-started>
    Connection Configuration </connect>
    Interact with Data </interact-data>
-   Model Your Data </model-data>
    Django Feature Limitations </feature-limitations>
    API Documentation <{+api+}>
 
@@ -49,11 +49,11 @@ a Django database backend that uses PyMongo to connect to MongoDB.
 .. Learn how to use {+django-odm+} to perform operations on MongoDB data
    in the :ref:`django-interact-data` section.
 
-.. Model Your Data
-.. ---------------
+Model Your Data
+---------------
 
-.. Learn how to create Django models that represent MongoDB collections
-   in the :ref:`django-model-data` section.
+Learn how to create Django models that represent MongoDB collections
+in the :ref:`django-model-data` section.
 
 .. Django Feature Limitations
 .. --------------------------

source/model-data.txt

@@ -0,0 +1,25 @@
+.. _django-model-data:
+
+===============
+Model Your Data
+===============
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :description: Learn how to use Django MongoDB Backend to model MongoDB data.
+   :keywords: field, query, collection, object
+
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   Create Models </model-data/models>