API reference¶
The hand-written public surface, rendered from its docstrings. It is small on purpose: the SDK’s bulk — the typed cursors of the design DSL, their keyword arguments and the enums behind them — is generated, and so is its reference (Vocabulary book).
If you are looking for… |
Go to |
|---|---|
the clients, the nodes, navigation |
|
the design DSL: roots, |
|
the fields of a maker ( |
|
reads: query builder and filters |
|
discovering any of the ~15,300 readable classes |
|
what a failure raises |
|
the model contract |
|
sessions, retries, the transport protocols |
|
diffing and response parsing |
- The
niwakipackage - Clients and nodes
- The design DSL
- Reading — queries and filters
- Discovery — the read catalogue
- niwaki.exceptions
APIErrorAmbiguousBindErrorAuthErrorConnectionErrorDeserializationErrorDesignErrorDuplicateDeclarationErrorForbiddenErrorLoginErrorMultipleResultsErrorNiwakiErrorNoResultErrorNotFoundErrorServerErrorSessionExpiredErrorStagedPushErrorStatsClassNotSubscribableErrorSubscribeRejectedErrorSubscriptionErrorSubscriptionLostErrorSubscriptionLostReasonTLSErrorTimeoutErrorTokenRefreshErrorTransportErrorUnauthorizedErrorUnknownMakerErrorUnresolvedReferenceError
- Models
- Transport
- Utilities