API Modules

The package reference lists names exported directly by fastapi_restly. The module references document their definitions and signatures.

• Package API
  • fastapi_restly.__version__
• Clauses API
  • ClauseNamespace
  • ContextNamespace
  • ContextParam
  • Unscoped
  • WhereClause
  • all_of()
  • any_of()
  • apply_clauses()
  • none_of()
  • where_clause()
  • UNSCOPED
• Database API
  • fastapi_restly.db.AsyncSessionDep
  • fastapi_restly.db.SessionDep
  • async_create_all()
  • configure()
  • create_all()
  • get_async_engine()
  • get_engine()
  • open_async_session()
  • open_session()
• Exceptions API
  • BadQueryParam
  • Conflict
  • Forbidden
  • NotFound
  • RestlyConfigurationError
  • RestlyDuplicateSchemaNameWarning
  • RestlyError
  • RestlyHTTPError
  • RestlyMisuseWarning
  • RestlyUncommittedChangesWarning
• Models API
  • DataclassBase
  • IDBase
  • IDMixin
  • TimestampsMixin
• Objects API
  • async_delete_object()
  • async_make_new_object()
  • async_save_object()
  • async_update_object()
  • delete_object()
  • make_new_object()
  • save_object()
  • snapshot()
  • update_object()
• Query API
  • apply_list_params()
  • derive_schema_list_params()
• Schemas API
  • fastapi_restly.schemas.ReadOnly
  • fastapi_restly.schemas.WriteOnly
  • BaseSchema
  • IDRef
  • IDSchema
  • MustExist
  • RefExists
  • TimestampsSchemaMixin
  • derive_schema()
  • derive_schema_list_response()
  • derive_schema_response()
• Views API
  • Action
  • AsyncReactAdminView
  • AsyncRestView
  • BaseRestView
  • Envelope
  • ListResult
  • NoPagination
  • NumberedPagination
  • PaginatedEnvelope
  • ReactAdminView
  • ResponseShape
  • RestView
  • View
  • ViewRoute
  • async_run_write_action()
  • delete()
  • get()
  • include_view()
  • patch()
  • post()
  • put()
  • resolve_scope()
  • route()
  • run_write_action()
• Testing API
  • AsyncRestlyTestClient
  • RestlyTestClient
  • configure_tests()
• Utils API
  • CurrentSettingsMixin