Similar to tables in a traditional relational database, collections are most commonly used to group a set of entities that are intended to store data related to a common purpose or feature. When working with your data in the API BaaS data store, you generally will work at the entity level; however, there are times when it is useful to make API request against entire collections, such as batch update operations.
Collection names are the plural form of the
type property of the entities it contains, i.e. the
/users collection stores entities with type
user and a
/people collection stores entities of type
person. When a data entity is created, a new collection is created with a name that corresponds to the
type property of the entity. If a corresponding collection already exists, the entity will automatically be added to it.
By default, all API BaaS data stores include a set of default collections that correspond to reserved default data entity types. These default entities are intended to support the primary features of the API BaaS. For example, a
user entity type with a corresponding
/users collection is reserved for modeling data related to app users, and includes properties to support special functionality, such as password authentication.
Learn more about:Default data entities
Collections are the most common way to organize your data in the API BaaS data store. Generally, you will work with your data at the entity level; however, there are times when it is useful to make API request against entire collections, such as batch update operations.
Learn more about:Creating collections Retrieving collections Updating collections Deleting collections
Help or comments?
- If something's not working: Ask the Apigee Community or see Apigee Support.
- If something's wrong with the docs: Send Docs Feedback
(Incorrect? Unclear? Broken link? Typo?)