Fields

beanie.odm.fields

Indexed

def Indexed(typ, index_type=ASCENDING, **kwargs)

Returns a subclass of typ with an extra attribute _indexed as a tuple: - Index 0: index_type such as pymongo.ASCENDING - Index 1: kwargs passed to IndexModel When instantiated the type of the result will actually be typ.

PydanticObjectId

class PydanticObjectId(ObjectId)

Object Id field. Compatible with Pydantic.

ExpressionField

class ExpressionField(str)

ExpressionField.__getitem__

def __getitem__(item)

Get sub field

Arguments:

• item: name of the subfield

Returns:

ExpressionField

ExpressionField.__getattr__

def __getattr__(item)

Get sub field

Arguments:

• item: name of the subfield

Returns:

ExpressionField

LinkInfo

class LinkInfo(BaseModel)

LinkInfo.model_class

Document class

Link

class Link(Generic[T])

Link.fetch_list

@classmethod
async def fetch_list(cls,
                     links: List[Union["Link", "DocType"]],
                     fetch_links: bool = False)

Fetch list that contains links and documents

Arguments:

• links:
• fetch_links:

BackLink

class BackLink(Generic[T])

Back reference to a document