Responses

Once a query is run, the library parses the server’s response into an APIResponse object.

class postgrest.APIResponse

data: List[_ReturnT]

The data returned by the query.

count: int | None

The number of rows returned.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'count': FieldInfo(annotation=Union[int, NoneType], required=False), 'data': FieldInfo(annotation=List[~_ReturnT], required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.