SDK
SDK Dart Null Safety v3.x
2

list #

Returns the list of collections associated to a provided index. The returned list is sorted in alphanumerical order.


Future<Map<String, dynamic>> list(
    String index, {int? from, int? size, String? type})
ArgumentsTypeDescription
index
String
Index name

Returns #

Returns a ConcurrentHashMap<String, Object> containing the following properties:

PropertyTypeDescription
type
String?
Types of returned collections
(all, realtime or stored)
from
int?
Offset of the first result
size
int?
Maximum number of returned results

Each object in the collections array contains the following properties:

PropertyTypeDescription
name
String
Collection name
type
String
Collection type (realtime or stored)

Usage #

final result = await kuzzle
  .collection
  .list('nyc-open-data', type: 'stored');