|API Method||Description||PHP Ruby JS Python iOS Android C# Java Go Scala name|
|Add objects|| |
Add new objects (records) to an index.
|Update objects|| |
Replace an existing object with an updated set of attributes.
|Partial update objects|| |
Update one or more attributes of an existing object.
|Delete objects|| |
Remove objects from an index using their object ids.
|Delete by query|| |
Remove all objects matching a query.
|Get objects|| |
Get one or more objects using their object ids.
|Wait for operations|| |
Wait for a task to complete before executing the next line of code, to synchronize index updates.
You don’t need to explicitly create an index, it will be automatically created the first time you add an object. Objects are schema less so you don’t need any configuration to start indexing. If you wish to configure things, the settings section provides details about advanced settings.
Object / Record
We use these 2 words interchangeably. Sometimes witin the same sentence. So don’t place any significance on their usage:
- Indexes contain objects or records
- JSON contains objects or records
All objects and records contain attributes … or fields, or elements. Within the search and indexing contexts, we often speak of settings and parameters. Again, these terms are mostly interchangeable.
Some attributes are simple key/value pairs. But others can be more complex, making it look more like a collection or an object.
Did you find this page helpful?
We're always looking for advice to help improve our documentation!
Please let us know what's working (or what's not!).
We're constantly iterating thanks to the feedback we receive.