Added Unique() examples in documentation

codemation · Aug 16, 2022 · 50a8a22 · 50a8a22
1 parent cf167ae
commit 50a8a22
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -26,11 +26,11 @@ $ pip install pydbantic[postgres]
 
 ```python
 from typing import List, Optional, Union
-from pydbantic import DataBaseModel, PrimaryKey
+from pydbantic import DataBaseModel, PrimaryKey, Unique
 
 class Department(DataBaseModel):
     department_id: str = PrimaryKey()
-    name: str
+    name: str = Unique()
     company: str
     is_sensitive: bool = False
     positions: List[Optional['Positions']] = []  # One to Many

diff --git a/docs/model-usage.md b/docs/model-usage.md
@@ -6,7 +6,7 @@
 ```python
 from typing import List, Optional
 from pydantic import BaseModel, Field
-from pydbantic import DataBaseModel, PrimaryKey
+from pydbantic import DataBaseModel, PrimaryKey, Unique
 
 class Coordinates(BaseModel):
 
@@ -30,6 +30,7 @@ class EmployeeInfo(DataBaseModel):
 
 class Employee(DataBaseModel):
     id: str = PrimaryKey()
+    bio_id: str = Unique()
     employee_info: EmployeeInfo
     position: Positions
     salary: float