API Reference

The library offers both synchronous and asynchronous clients. Note that the synchronous and asynchronous classes all provide the exact same interface.

Contents:

• Client
  • AsyncPostgrestClient
    • AsyncPostgrestClient.__init__()
    • AsyncPostgrestClient.aclose()
    • AsyncPostgrestClient.from_()
    • AsyncPostgrestClient.table()
    • AsyncPostgrestClient.from_table()
    • AsyncPostgrestClient.rpc()
    • AsyncPostgrestClient.auth()
    • AsyncPostgrestClient.schema()
  • SyncPostgrestClient
    • SyncPostgrestClient.__init__()
    • SyncPostgrestClient.aclose()
    • SyncPostgrestClient.from_()
    • SyncPostgrestClient.table()
    • SyncPostgrestClient.from_table()
    • SyncPostgrestClient.rpc()
    • SyncPostgrestClient.auth()
    • SyncPostgrestClient.schema()
• Request Builders
  • AsyncRequestBuilder
    • AsyncRequestBuilder.__init__()
    • AsyncRequestBuilder.select()
    • AsyncRequestBuilder.insert()
    • AsyncRequestBuilder.upsert()
    • AsyncRequestBuilder.update()
    • AsyncRequestBuilder.delete()
  • AsyncSelectRequestBuilder
    • AsyncSelectRequestBuilder.__init__()
    • AsyncSelectRequestBuilder.single()
    • AsyncSelectRequestBuilder.maybe_single()
    • AsyncSelectRequestBuilder.csv()
    • AsyncSelectRequestBuilder.eq()
    • AsyncSelectRequestBuilder.execute()
    • AsyncSelectRequestBuilder.filter()
    • AsyncSelectRequestBuilder.gt()
    • AsyncSelectRequestBuilder.gte()
    • AsyncSelectRequestBuilder.ilike()
    • AsyncSelectRequestBuilder.ilike_all_of()
    • AsyncSelectRequestBuilder.ilike_any_of()
    • AsyncSelectRequestBuilder.is_()
    • AsyncSelectRequestBuilder.like()
    • AsyncSelectRequestBuilder.like_all_of()
    • AsyncSelectRequestBuilder.like_any_of()
    • AsyncSelectRequestBuilder.limit()
    • AsyncSelectRequestBuilder.lt()
    • AsyncSelectRequestBuilder.lte()
    • AsyncSelectRequestBuilder.neq()
    • AsyncSelectRequestBuilder.not_
    • AsyncSelectRequestBuilder.offset()
    • AsyncSelectRequestBuilder.or_()
    • AsyncSelectRequestBuilder.order()
  • AsyncQueryRequestBuilder
    • AsyncQueryRequestBuilder.__init__()
    • AsyncQueryRequestBuilder.execute()
  • SyncRequestBuilder
    • SyncRequestBuilder.__init__()
    • SyncRequestBuilder.select()
    • SyncRequestBuilder.insert()
    • SyncRequestBuilder.upsert()
    • SyncRequestBuilder.update()
    • SyncRequestBuilder.delete()
  • SyncSelectRequestBuilder
    • SyncSelectRequestBuilder.__init__()
    • SyncSelectRequestBuilder.single()
    • SyncSelectRequestBuilder.maybe_single()
    • SyncSelectRequestBuilder.csv()
    • SyncSelectRequestBuilder.eq()
    • SyncSelectRequestBuilder.execute()
    • SyncSelectRequestBuilder.filter()
    • SyncSelectRequestBuilder.gt()
    • SyncSelectRequestBuilder.gte()
    • SyncSelectRequestBuilder.ilike()
    • SyncSelectRequestBuilder.ilike_all_of()
    • SyncSelectRequestBuilder.ilike_any_of()
    • SyncSelectRequestBuilder.is_()
    • SyncSelectRequestBuilder.like()
    • SyncSelectRequestBuilder.like_all_of()
    • SyncSelectRequestBuilder.like_any_of()
    • SyncSelectRequestBuilder.limit()
    • SyncSelectRequestBuilder.lt()
    • SyncSelectRequestBuilder.lte()
    • SyncSelectRequestBuilder.neq()
    • SyncSelectRequestBuilder.not_
    • SyncSelectRequestBuilder.offset()
    • SyncSelectRequestBuilder.or_()
    • SyncSelectRequestBuilder.order()
  • SyncQueryRequestBuilder
    • SyncQueryRequestBuilder.__init__()
    • SyncQueryRequestBuilder.execute()
• Filters
  • AsyncFilterRequestBuilder
    • AsyncFilterRequestBuilder.__init__()
    • AsyncFilterRequestBuilder.adj()
    • AsyncFilterRequestBuilder.cd()
    • AsyncFilterRequestBuilder.contained_by()
    • AsyncFilterRequestBuilder.contains()
    • AsyncFilterRequestBuilder.cs()
    • AsyncFilterRequestBuilder.eq()
    • AsyncFilterRequestBuilder.execute()
    • AsyncFilterRequestBuilder.filter()
    • AsyncFilterRequestBuilder.fts()
    • AsyncFilterRequestBuilder.gt()
    • AsyncFilterRequestBuilder.gte()
    • AsyncFilterRequestBuilder.ilike()
    • AsyncFilterRequestBuilder.ilike_all_of()
    • AsyncFilterRequestBuilder.ilike_any_of()
    • AsyncFilterRequestBuilder.in_()
    • AsyncFilterRequestBuilder.is_()
    • AsyncFilterRequestBuilder.like()
    • AsyncFilterRequestBuilder.like_all_of()
    • AsyncFilterRequestBuilder.like_any_of()
    • AsyncFilterRequestBuilder.lt()
    • AsyncFilterRequestBuilder.lte()
    • AsyncFilterRequestBuilder.match()
    • AsyncFilterRequestBuilder.neq()
    • AsyncFilterRequestBuilder.not_
    • AsyncFilterRequestBuilder.nxl()
    • AsyncFilterRequestBuilder.nxr()
    • AsyncFilterRequestBuilder.or_()
    • AsyncFilterRequestBuilder.ov()
    • AsyncFilterRequestBuilder.overlaps()
    • AsyncFilterRequestBuilder.phfts()
    • AsyncFilterRequestBuilder.plfts()
    • AsyncFilterRequestBuilder.range_adjacent()
    • AsyncFilterRequestBuilder.range_gt()
    • AsyncFilterRequestBuilder.range_gte()
    • AsyncFilterRequestBuilder.range_lt()
    • AsyncFilterRequestBuilder.range_lte()
    • AsyncFilterRequestBuilder.sl()
    • AsyncFilterRequestBuilder.sr()
    • AsyncFilterRequestBuilder.wfts()
  • SyncFilterRequestBuilder
    • SyncFilterRequestBuilder.__init__()
    • SyncFilterRequestBuilder.adj()
    • SyncFilterRequestBuilder.cd()
    • SyncFilterRequestBuilder.contained_by()
    • SyncFilterRequestBuilder.contains()
    • SyncFilterRequestBuilder.cs()
    • SyncFilterRequestBuilder.eq()
    • SyncFilterRequestBuilder.execute()
    • SyncFilterRequestBuilder.filter()
    • SyncFilterRequestBuilder.fts()
    • SyncFilterRequestBuilder.gt()
    • SyncFilterRequestBuilder.gte()
    • SyncFilterRequestBuilder.ilike()
    • SyncFilterRequestBuilder.ilike_all_of()
    • SyncFilterRequestBuilder.ilike_any_of()
    • SyncFilterRequestBuilder.in_()
    • SyncFilterRequestBuilder.is_()
    • SyncFilterRequestBuilder.like()
    • SyncFilterRequestBuilder.like_all_of()
    • SyncFilterRequestBuilder.like_any_of()
    • SyncFilterRequestBuilder.lt()
    • SyncFilterRequestBuilder.lte()
    • SyncFilterRequestBuilder.match()
    • SyncFilterRequestBuilder.neq()
    • SyncFilterRequestBuilder.not_
    • SyncFilterRequestBuilder.nxl()
    • SyncFilterRequestBuilder.nxr()
    • SyncFilterRequestBuilder.or_()
    • SyncFilterRequestBuilder.ov()
    • SyncFilterRequestBuilder.overlaps()
    • SyncFilterRequestBuilder.phfts()
    • SyncFilterRequestBuilder.plfts()
    • SyncFilterRequestBuilder.range_adjacent()
    • SyncFilterRequestBuilder.range_gt()
    • SyncFilterRequestBuilder.range_gte()
    • SyncFilterRequestBuilder.range_lt()
    • SyncFilterRequestBuilder.range_lte()
    • SyncFilterRequestBuilder.sl()
    • SyncFilterRequestBuilder.sr()
    • SyncFilterRequestBuilder.wfts()
• Responses
  • APIResponse
    • APIResponse.data
    • APIResponse.count
    • APIResponse.model_config
    • APIResponse.model_fields
• Types
  • CountMethod
  • Filters
  • RequestMethod
  • ReturnMethod
• Exceptions
  • APIError
    • APIError.__init__()
    • APIError.message
    • APIError.code
    • APIError.hint
    • APIError.details
    • APIError.json()