svc-infra / API Reference

NoSqlResource

from svc_infra.db.nosql.resource import NoSqlResource

svc_infra.db.nosql.resource

Mongo resource declaration used by API & CLI. Define indexes here (either IndexModel or simple alias dicts).

Constructor

NoSqlResource(collection: str | None = None, prefix: str = '', document_model: type[Any] | None = None, read_schema: type[Any] | None = None, create_schema: type[Any] | None = None, update_schema: type[Any] | None = None, search_fields: Sequence[str] | None = None, tags: list[str] | None = None, id_field: str = '_id', soft_delete: bool = False, soft_delete_field: str = 'deleted_at', soft_delete_flag_field: str | None = None, service_factory: Callable[[Any], Any] | None = None, read_name: str | None = None, create_name: str | None = None, update_name: str | None = None, create_exclude: tuple[str, ...] = ('_id',), read_exclude: tuple[str, ...] = (), update_exclude: tuple[str, ...] = (), indexes: Iterable[IndexModel | IndexAlias] | None = None) -> None

Parameter	Type	Default	Description
`collection`	`str\|None`	None	—
`prefix`	`str`	''	—
`document_model`	`type[Any] \|None`	None	—
`read_schema`	`type[Any] \|None`	None	—
`create_schema`	`type[Any] \|None`	None	—
`update_schema`	`type[Any] \|None`	None	—
`search_fields`	`Sequence[str] \|None`	None	—
`tags`	`list[str] \|None`	None	—
`id_field`	`str`	'_id'	—
`soft_delete`	`bool`	False	—
`soft_delete_field`	`str`	'deleted_at'	—
`soft_delete_flag_field`	`str\|None`	None	—
`service_factory`	`Callable[[Any], Any] \|None`	None	—
`read_name`	`str\|None`	None	—
`create_name`	`str\|None`	None	—
`update_name`	`str\|None`	None	—
`create_exclude`	`tuple[str, ...]`	('_id',)	—
`read_exclude`	`tuple[str, ...]`	()	—
`update_exclude`	`tuple[str, ...]`	()	—
`indexes`	`Iterable[IndexModel \| IndexAlias] \|None`	None	—

NoSqlResource

Methods

NoSqlResource

Methods