The collections are sets of records that are kept in the database. The database can host many collections.
This part of the interface shows us all the collections that exist in our system. From there we have the following abilities:
- See all of the collections in the system as well as how many they are(bottom)
- Search for a specific collection.
- Create a collection, by clicking on the plus button in the bottom right.
- Update a collection, by clicking on it's name.
- Delete a collection, by right clicking on it's name and selecting the delete option.
This part of the interface allows us to create and update collections. Each collection consists of the following:
- Data structure
- Relations We will explain the data structure and relations further below.
This part of the interface allows us to configure the fields that we want out collection to have. We can add a field by clicking on the + button that appears upon hovering on the number on the left For each field that we add we need to fill in the following information:
- Type: The type can be one of the following:
- List (Array)
- Text (String)
- Static Option: a set of named constants.
- Index: The index can have one of the following values:
- No Index.
- Filter Index: when we set a field as a filter index, we can use it as a filter in a query or subscription.
- Search Index: when we set a field as a search field, we are able to search and find the records that have a specific value for this field. We can do that with a query.
The relations term describes the connection between two collections. This means that there can be a field in one collection that refers to a record or records of another collection.
In the Relations part of the interface, we can see an overview of those relations.
If we want to add a relation we click the "ADD RELATION" button and we input the following information in the window that pops up:
- To service: The collection to make a relation with.
- Relationship on current service object: Current collection.
- Property name on current service object: The name of the relation field in the current collection.
- Relation resolve path to service object: The query that the relation will use.
- Relation arguments to query: In this table the query attributes have to be input.