list #

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

Copied to clipboard!

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

Arguments	Type	Description
index	String	Index name

Returns #

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

Property	Type	Description
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:

Property	Type	Description
name	String	Collection name
type	String	Collection type (realtime or stored)

Usage #

Copied to clipboard!

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