code | type | title | description | order |
---|---|---|---|---|
true |
page |
constructor |
Collection:constructor |
1 |
In Kuzzle, you manipulate documents and subscriptions, both related to collections.
A collection is a set of data managed by Kuzzle. It acts like a data table for persistent documents, or like a room for pub/sub messages.
Arguments | Type | Description |
---|---|---|
kuzzle |
object | Kuzzle object |
collection |
string | The name of the collection you want to manipulate |
index |
string | Name of the index containing the collection |
Note: We recommend you instantiate a Collection object by calling Kuzzle.collection rather than using the constructor directly
Property name | Type | Description | get/set |
---|---|---|---|
collection |
string | The name of the collection handled by this instance | get |
index |
object | Name of the index containing the collection | get |
headers |
object | Headers for all sent documents. | get/set |
kuzzle |
object | linked Kuzzle instance | get |
Note: the headers
property is inherited from the main Kuzzle
object and can be overrided
<<< ./snippets/constructor-1.php