File tree Expand file tree Collapse file tree 2 files changed +20
-2
lines changed Expand file tree Collapse file tree 2 files changed +20
-2
lines changed Original file line number Diff line number Diff line change @@ -6,7 +6,16 @@ import Foundation
6
6
import Core
7
7
#endif
8
8
9
- /// Type of indexing operation.
9
+ /// Which indexing operation to perform: - `addObject`: adds records to an index. Equivalent to the \"Add a new
10
+ /// record (with auto-generated object ID)\" operation. - `updateObject`: adds or replaces records in an index.
11
+ /// Equivalent to the \"Add or replace a record\" operation. - `partialUpdateObject`: adds or updates attributes within
12
+ /// records. Equivalent to the \"Add or update attributes\" operation with the `createIfNoExists` parameter set to
13
+ /// true. (If a record with the specified `objectID` doesn't exist in the specified index, this action creates adds
14
+ /// the record to the index) - `partialUpdateObjectNoCreate`: same as `partialUpdateObject`, but with `createIfNoExists`
15
+ /// set to false. (A record isn't added to the index if its `objectID` doesn't exist) - `deleteObject`: delete
16
+ /// records from an index. Equivalent to the \"Delete a record\" operation. - `delete`. Delete an index. Equivalent to
17
+ /// the \"Delete an index\" operation. - `clear`: delete all records from an index. Equivalent to the \"Delete all
18
+ /// records from an index operation\".
10
19
public enum IngestionAction : String , Codable , CaseIterable {
11
20
case addObject
12
21
case updateObject
Original file line number Diff line number Diff line change @@ -6,7 +6,16 @@ import Foundation
6
6
import Core
7
7
#endif
8
8
9
- /// Type of indexing operation.
9
+ /// Which indexing operation to perform: - `addObject`: adds records to an index. Equivalent to the \"Add a new
10
+ /// record (with auto-generated object ID)\" operation. - `updateObject`: adds or replaces records in an index.
11
+ /// Equivalent to the \"Add or replace a record\" operation. - `partialUpdateObject`: adds or updates attributes within
12
+ /// records. Equivalent to the \"Add or update attributes\" operation with the `createIfNoExists` parameter set to
13
+ /// true. (If a record with the specified `objectID` doesn't exist in the specified index, this action creates adds
14
+ /// the record to the index) - `partialUpdateObjectNoCreate`: same as `partialUpdateObject`, but with `createIfNoExists`
15
+ /// set to false. (A record isn't added to the index if its `objectID` doesn't exist) - `deleteObject`: delete
16
+ /// records from an index. Equivalent to the \"Delete a record\" operation. - `delete`. Delete an index. Equivalent to
17
+ /// the \"Delete an index\" operation. - `clear`: delete all records from an index. Equivalent to the \"Delete all
18
+ /// records from an index operation\".
10
19
public enum SearchAction : String , Codable , CaseIterable {
11
20
case addObject
12
21
case updateObject
You can’t perform that action at this time.
0 commit comments