SCUpdate

SCUpdate

Содержание

• SCUpdate
  • .addOperator(oper: SCUpdateOperator)
  • .set(dic: [String: SCValue])
  • .push(name: String, _ value: SCValue)
  • .pushEach(name: String, _ value: SCValue)
  • .pull(name: String, _ value: SCPullable)
  • .pullAll(name: String, _ value: SCValue)
  • .addToSet(name: String, _ value: SCValue)
  • .addToSetEach(name: String, _ value: SCValue)
  • .pop(name: String, _ value: Int)
  • .inc(name: String, _ value: SCValue)
  • .currentDate(name: String, typeSpec: String)
  • .mul(name: String, _ value: SCValue)
  • .min(name: String, _ value: SCValue)
  • .max(name: String, _ value: SCValue)

---

.addOperator(name, oper)

Метод для передачи SCUpdate оператора для изменения данных

Параметр	Тип	Свойства	Описание	Пример значения
oper	SCUpdateOperator	Обязательное	Условие выборки

Пример

var update = SCUpdate()
let currentDate = SCUpdateOperator.currentDate("fieldName", typeSpec: "timestamp")
update.addOperator(currentDate)

---

.set(dic: [String: SCValue])

Метод для передачи данных объекту

Параметр	Тип	Свойства	Описание	Пример значения
dic	[String: SCValue]		Объект с данными для передачи объекту	["fieldString": SCString("NewValue")]

Пример

var update = SCUpdate()
update.set(["fieldName": SCString("A")])

---

.push(name: String, _ value: SCValue)

Метод для добавления элемента в массив.

Параметр	Тип	Свойства	Описание	Пример значения
name	String	Обязательный	Имя поля, значение которого нужно изменить	"tags"
_ value	SCValue	Обязательный	Значение нового элемента массива	42

Пример

var update = SCUpdate()
update.push("fieldName", SCString("A"))
update.save()

---

.pushEach(name: String, _ value: SCValue)

Метод для добавления нескольких элементов в массив.

Параметр	Тип	Свойства	Описание	Пример значения
name	String	Обязательный	Имя поля, значение которого нужно изменить	"tags"
_ value	SCValue	Обязательный	Значения новых элементов массива	42, [43,43], 44

Пример

var update = SCUpdate()
update.pushEach("fieldName", SCArray([SCString("A")]))

---

.pull(name: String, _ value: SCPullable)

Метод для удаления всех элементов массива, значение которых равно указанному.

Параметр	Тип	Свойства	Описание	Пример значения
name	String	Обязательный	Имя поля, значение которого нужно изменить	"tags"
_ value	SCPullable	Обязательный	Удаляемое значение	42

Пример

var update = SCUpdate()
update.pull("fieldName", SCString("A"))

---

.pullAll(name: String, _ value: SCValue)

Метод для удаления всех элементов массива, значения которых равны одному из указанных значений.

Параметр	Тип	Свойства	Описание	Пример значения
name	String	Обязательный	Имя поля, значение которого нужно изменить	"tags"
_ value	SCValue	Обязательный	Массив удаляемых значений	[42, 44]

Пример

var update = SCUpdate()
update.pullAll("fieldName", SCArray([SCString("A")]))

---

.addToSet(name: String, _ value: SCValue)

Метод для добавления элемента в массив только в том случае, если в массиве отсутствуют элементы с таким значением.

Параметр	Тип	Свойства	Описание	Пример значения
name	String	Обязательный	Имя поля, значение которого нужно изменить	"tags"
_ value	SCValue	Обязательный	Значение нового элемента массива	42

Пример

var update = SCUpdate()
update.addToSet("fieldName", SCString("A"))

---

.addToSetEach(name: String, _ value: SCValue)

Метод для добавления элементов в массив только в том случае, если в массиве отсутствуют элементы с таким значением.

Параметр	Тип	Свойства	Описание	Пример значения
name	String	Обязательный	Имя поля, значение которого нужно изменить	"tags"
_ value	SCValue	Обязательный	Массив значений новых элементов массива	[42, 43]

Пример

var update = SCUpdate()
update.addToSetEach("fieldName", SCArray(SCString("A"))

---

.pop(name: String, _ value: Int)

Метод для удаления первого или последнего элемента массива

Параметр	Тип	Свойства	Описание	Пример значения
name	String	Обязательный	Имя поля, значение которого нужно изменить	"tags"
_ value	Int	Обязательный	Позиция удаляемого элемента в массиве: -1 для первого элемента и 1 для последнего	-1

Пример

var update = SCUpdate()
update.pop("fieldName", 1)

---

.inc(name: String, _ value: SCValue)

Метод увеличивает значение числового поля на заданное число

Параметр	Тип	Свойства	Описание	Пример значения
name	String	Обязательный	Имя поля, значение которого нужно изменить	"price"
_ value	SCValue	Обязательный	Шаг изменения	5

Пример

var update = SCUpdate()
update.inc("fieldName", SCInt(1))

---

.currentDate(name: String, typeSpec: String)

Устанавливает текущее время в качестве значения поля

Параметр	Тип	Свойства	Описание	Пример значения
name	String	Обязательный	Имя поля, значение которого нужно изменить	"price"
typeSpec	SCValue	Обязательный	Тип даты. Принимает значения: true, 'date' или 'timestamp'	"timestamp"

Пример

var update = SCUpdate()
update.currentDate("fieldName", typeSpec: "date")

---

.mul(name: String, _ value: SCValue)

Метод умножает значение числового поля на заданное число

Параметр	Тип	Свойства	Описание	Пример значения
name	String	Обязательный	Имя поля, значение которого нужно изменить	"price"
_ value	SCValue	Обязательный	Мультипликатор	2.5

Пример

var update = SCUpdate()
update.mul("fieldName", SCInt(5))

---

.min(name: String, _ value: SCValue)

Метод обновляет значение числового поля только в случае, если новое значение меньше текущего значения поля

Параметр	Тип	Свойства	Описание	Пример значения
name	String	Обязательный	Имя поля, значение которого нужно изменить	"price"
_ value	SCValue	Обязательный	Новое значение	42

Пример

var update = SCUpdate()
update.min("fieldName", SCInt(5))

---

.max(name: String, _ value: SCValue)

Метод обновляет значение числового поля только в случае, если новое значение больше текущего значения поля

Параметр	Тип	Свойства	Описание	Пример значения
name	String	Обязательный	Имя поля, значение которого нужно изменить	"price"
_ value	SCValue	Обязательный	Новое значение	42

Пример

var update = SCUpdate()
update.max("fieldName", SCInt(5))