getAllToStream abstract method

Future<Stream<Map<String, dynamic>>> getAllToStream(
  1. DbPrincipal principal, {
  2. SearchPolicy? searchPolicy,
  3. RepositoryTransaction? transaction,
})

Gets all the entities from the collection identified by the key parameter. Use this method only with collections where the number of elements in the collection (per tenant) is guaranteed to be very limited.

This method expects a principal parameter, which identifies the user performing the request. Implementations are advised to filter the returned elements by the tenant of the principal.

If a non-empty value is passed to the permission parameter, the implementation of this method is expected to validate if the user represented by the principal does have the permission before actually returning the elements. Otherwise, an error is thrown.

Implementation

Future<Stream<Map<String, dynamic>>> getAllToStream(
  DbPrincipal principal, {
  SearchPolicy? searchPolicy,
  RepositoryTransaction? transaction,
});