update docs part 2

docs_src/fields/docs001.py

@@ -8,21 +8,23 @@ metadata = sqlalchemy.MetaData()
 
 
 class Department(ormar.Model):
-    __database__ = database
-    __metadata__ = metadata
+    class Meta:
+        database = database
+        metadata = metadata
 
-    id = ormar.Integer(primary_key=True)
-    name = ormar.String(length=100)
+    id: ormar.Integer(primary_key=True)
+    name: ormar.String(max_length=100)
 
 
 class Course(ormar.Model):
-    __database__ = database
-    __metadata__ = metadata
+    class Meta:
+        database = database
+        metadata = metadata
 
-    id = ormar.Integer(primary_key=True)
-    name = ormar.String(length=100)
-    completed = ormar.Boolean(default=False)
-    department = ormar.ForeignKey(Department)
+    id: ormar.Integer(primary_key=True)
+    name: ormar.String(max_length=100)
+    completed: ormar.Boolean(default=False)
+    department: ormar.ForeignKey(Department)
 
 
 department = Department(name='Science')

docs_src/fields/docs002.py

@@ -8,21 +8,24 @@ metadata = sqlalchemy.MetaData()
 
 
 class Department(ormar.Model):
-    __database__ = database
-    __metadata__ = metadata
+    class Meta:
+        database = database
+        metadata = metadata
 
-    id = ormar.Integer(primary_key=True)
-    name = ormar.String(length=100)
+    id: ormar.Integer(primary_key=True)
+    name: ormar.String(max_length=100)
 
 
 class Course(ormar.Model):
-    __database__ = database
-    __metadata__ = metadata
+    class Meta:
+        database = database
+        metadata = metadata
+
+    id: ormar.Integer(primary_key=True)
+    name: ormar.String(max_length=100)
+    completed: ormar.Boolean(default=False)
+    department: ormar.ForeignKey(Department, related_name="my_courses")
 
-    id = ormar.Integer(primary_key=True)
-    name = ormar.String(length=100)
-    completed = ormar.Boolean(default=False)
-    department = ormar.ForeignKey(Department, related_name="my_courses")
 
 department = Department(name='Science')
 course = Course(name='Math', completed=False, department=department)
@@ -33,4 +36,3 @@ print(department.my_courses[0])
 #        name='Math',
 #        completed=False,
 #        department=Department(id=None, name='Science'))
-

docs_src/fields/docs003.py

@@ -1,41 +1,27 @@
-import ormar
 import databases
 import sqlalchemy
 
+import ormar
+
 database = databases.Database("sqlite:///db.sqlite")
 metadata = sqlalchemy.MetaData()
 
 
-class Album(ormar.Model):
-    __tablename__ = "album"
-    __metadata__ = metadata
-    __database__ = database
+class Department(ormar.Model):
+    class Meta:
+        database = database
+        metadata = metadata
 
-    id = ormar.Integer(primary_key=True)
-    name = ormar.String(length=100)
+    id: ormar.Integer(primary_key=True)
+    name: ormar.String(max_length=100)
 
 
-class Track(ormar.Model):
-    __tablename__ = "track"
-    __metadata__ = metadata
-    __database__ = database
+class Course(ormar.Model):
+    class Meta:
+        database = database
+        metadata = metadata
 
-    id = ormar.Integer(primary_key=True)
-    album = ormar.ForeignKey(Album, nullable=False)
-    title = ormar.String(length=100)
-    position = ormar.Integer()
-
-
-album = await Album.objects.create(name="Brooklyn")
-await Track.objects.create(album=album, title="The Bird", position=1)
-
-# explicit preload of columns Album Model
-track = await Track.objects.select_related("album").get(title="The Bird")
-assert track.album.name == 'Brooklyn'
-# Will produce: True
-
-# even without explicit select_related if ForeignKey is not nullable,
-# the Album Model is still preloaded.
-track2 = await Track.objects.get(title="The Bird")
-assert track2.album.name == 'Brooklyn'
-# Will produce: True
+    id: ormar.Integer(primary_key=True)
+    name: ormar.String(max_length=100)
+    completed: ormar.Boolean(default=False)
+    department: ormar.ForeignKey(Department)

docs_src/models/docs006.py

@@ -0,0 +1,21 @@
+import databases
+import sqlalchemy
+
+import ormar
+
+database = databases.Database("sqlite:///db.sqlite")
+metadata = sqlalchemy.MetaData()
+
+
+class Course(ormar.Model):
+    class Meta:
+        database = database
+        metadata = metadata
+        # define your constraints in Meta class of the model
+        # it's a list that can contain multiple constraints
+        # hera a combination of name and column will have to be unique in db
+        constraints = [ormar.UniqueColumns('name', 'completed')]
+
+    id = ormar.Integer(primary_key=True)
+    name = ormar.String(max_length=100)
+    completed = ormar.Boolean(default=False)

docs_src/queries/docs001.py

@@ -0,0 +1,28 @@
+import databases
+import ormar
+import sqlalchemy
+
+database = databases.Database("sqlite:///db.sqlite")
+metadata = sqlalchemy.MetaData()
+
+
+class Album(ormar.Model):
+    class Meta:
+        tablename = "album"
+        metadata = metadata
+        database = database
+
+    id: ormar.Integer(primary_key=True)
+    name: ormar.String(max_length=100)
+
+
+class Track(ormar.Model):
+    class Meta:
+        tablename = "track"
+        metadata = metadata
+        database = database
+
+    id: ormar.Integer(primary_key=True)
+    album: ormar.ForeignKey(Album)
+    title: ormar.String(max_length=100)
+    position: ormar.Integer()

docs_src/relations/docs001.py

@@ -1,26 +1,42 @@
-import ormar
 import databases
 import sqlalchemy
 
+import ormar
+
 database = databases.Database("sqlite:///db.sqlite")
 metadata = sqlalchemy.MetaData()
 
 
-class Album(ormar.Model):
-    __tablename__ = "album"
-    __metadata__ = metadata
-    __database__ = database
+class Department(ormar.Model):
+    class Meta:
+        database = database
+        metadata = metadata
 
-    id = ormar.Integer(primary_key=True)
-    name = ormar.String(length=100)
+    id: ormar.Integer(primary_key=True)
+    name: ormar.String(max_length=100)
 
 
-class Track(ormar.Model):
-    __tablename__ = "track"
-    __metadata__ = metadata
-    __database__ = database
+class Course(ormar.Model):
+    class Meta:
+        database = database
+        metadata = metadata
 
-    id = ormar.Integer(primary_key=True)
-    album = ormar.ForeignKey(Album)
-    title = ormar.String(length=100)
-    position = ormar.Integer()
+    id: ormar.Integer(primary_key=True)
+    name: ormar.String(max_length=100)
+    completed: ormar.Boolean(default=False)
+    department: ormar.ForeignKey(Department)
+
+
+department = Department(name='Science')
+
+# set up a relation with actual Model instance
+course = Course(name='Math', completed=False, department=department)
+
+# set up  relation with only related model pk value
+course2 = Course(name='Math II', completed=False, department=department.pk)
+
+# set up a relation with dictionary corresponding to related model
+course3 = Course(name='Math III', completed=False, department=department.dict())
+
+# explicitly set up None
+course4 = Course(name='Math III', completed=False, department=None)

docs_src/relations/docs002.py

@@ -1,39 +1,48 @@
-import ormar
 import databases
+import ormar
 import sqlalchemy
 
 database = databases.Database("sqlite:///db.sqlite")
 metadata = sqlalchemy.MetaData()
 
 
-class Album(ormar.Model):
-    __tablename__ = "album"
-    __metadata__ = metadata
-    __database__ = database
+class Author(ormar.Model):
+    class Meta:
+        tablename = "authors"
+        database = database
+        metadata = metadata
 
-    id = ormar.Integer(primary_key=True)
-    name = ormar.String(length=100)
+    id: ormar.Integer(primary_key=True)
+    first_name: ormar.String(max_length=80)
+    last_name: ormar.String(max_length=80)
 
 
-class Track(ormar.Model):
-    __tablename__ = "track"
-    __metadata__ = metadata
-    __database__ = database
+class Category(ormar.Model):
+    class Meta:
+        tablename = "categories"
+        database = database
+        metadata = metadata
 
-    id = ormar.Integer(primary_key=True)
-    album = ormar.ForeignKey(Album)
-    title = ormar.String(length=100)
-    position = ormar.Integer()
+    id: ormar.Integer(primary_key=True)
+    name: ormar.String(max_length=40)
 
 
-print(Track.__table__.columns['album'].__repr__())
-# Will produce:
-# Column('album', Integer(), ForeignKey('album.id'), table=<track>)
+class PostCategory(ormar.Model):
+    class Meta:
+        tablename = "posts_categories"
+        database = database
+        metadata = metadata
 
-print(Track.__pydantic_model__.__fields__['album'])
-# Will produce:
-# ModelField(
-#   name='album'
-#   type=Optional[Album]
-#   required=False
-#   default=None)
+    # If there are no additional columns id will be created automatically as Integer
+
+
+class Post(ormar.Model):
+    class Meta:
+        tablename = "posts"
+        database = database
+        metadata = metadata
+
+    id: ormar.Integer(primary_key=True)
+    title: ormar.String(max_length=200)
+    categories: ormar.ManyToMany(Category, through=PostCategory)
+    author: ormar.ForeignKey(Author)

docs_src/relations/docs003.py

@@ -1,44 +0,0 @@
-import databases
-import sqlalchemy
-import ormar
-
-database = databases.Database("sqlite:///db.sqlite")
-metadata = sqlalchemy.MetaData()
-
-
-class SchoolClass(ormar.Model):
-    __tablename__ = "schoolclasses"
-    __metadata__ = metadata
-    __database__ = database
-
-    id = ormar.Integer(primary_key=True)
-    name = ormar.String(length=100)
-
-
-class Category(ormar.Model):
-    __tablename__ = "categories"
-    __metadata__ = metadata
-    __database__ = database
-
-    id = ormar.Integer(primary_key=True)
-    name = ormar.String(length=100)
-
-
-class Student(ormar.Model):
-    __metadata__ = metadata
-    __database__ = database
-
-    id = ormar.Integer(primary_key=True)
-    name = ormar.String(length=100)
-    schoolclass = ormar.ForeignKey(SchoolClass)
-    category = ormar.ForeignKey(Category)
-
-
-class Teacher(ormar.Model):
-    __metadata__ = metadata
-    __database__ = database
-
-    id = ormar.Integer(primary_key=True)
-    name = ormar.String(length=100)
-    schoolclass = ormar.ForeignKey(SchoolClass)
-    category = ormar.ForeignKey(Category)