Mutation

Create

To create a new record, you can use the create method on the store. This method takes an object with the properties of the record you want to create.

const newTodo = await store.todos.create({
  title: 'New Todo',
  completed: false,
})

Update

To update an existing record, you can use the update method on the store. This method takes an object with the properties you want to update and the key of the record you want to update.

const updatedTodo = await store.todos.update({
  completed: true,
}, {
  key: 'some-id',
})

If you don't provide the key, rstore will attempt to compute the key from the object you pass to the update method. (See getKey for more details on how to compute the key.)

const updatedTodo = await store.todos.update({
  id: 'some-id',
  completed: true,
})

You can also update the record directly by using the $update method on the record itself. This method takes an object with the properties you want to update.

const todo = await store.todos.findFirst('some-id')

if (todo) {
  await todo.$update({
    completed: true,
  })
}

This also works with the reactive query and liveQuery methods:

const { data: todo } = await store.todos.query(q => q.first('some-id'))

async function toggle() {
  if (todo.value) {
    await todo.value.$update({
      completed: !todo.value.completed,
    })
  }
}

Delete

To delete a record, you can use the delete method on the store. This method takes the key of the record you want to delete.

await store.todos.delete('some-id')

You can also pass an object that contains the key of the record you want to delete. (See getKey for more details on how to compute the key.)

await store.todos.delete({
  id: 'some-id',
})

You can also pass an entire record to the delete method.

const todo = await store.todos.findFirst('some-id')

if (todo) {
  await store.todos.delete(todo)
}

You can also delete the record directly by using the $delete method on the record itself. This method does not take any arguments.

const todo = await store.todos.findFirst('some-id')

if (todo) {
  await todo.$delete()
}

Optimistic Updates

By default, rstore will try to perform optimistic updates when you create, update or delete a record. This means that the record will be updated in the store immediately, without waiting for the server to confirm the change. If an error is thrown during the mutation, the change will be automatically reverted.

You can disable optimistic updates by passing the optimistic: false option to the mutation method.

const newTodo = await store.todos.create({
  title: 'New Todo',
  completed: false,
}, {
  optimistic: false,
})

myTodo.$update({
  completed: true,
}, {
  optimistic: false,
})

const editForm = await store.todos.updateForm({
  key: 'my-id',
  optimistic: false,
})

You can customize the expected result of the mutation by passing an object to the optimistic option. It will be merged with the data you pass to the mutation method but can override it.

const newTodo = await store.todos.create({
  title: 'New Todo',
  completed: false,
}, {
  optimistic: {
    id: 'temp-id',
    createdAt: new Date().toISOString(),
  },
})

/*
The optimistic object will be:
{
  id: 'temp-id', // added
  title: 'New Todo',
  completed: false,
  createdAt: '2024-06-01T12:00:00.000Z', // added
}
*/

To know if a record is optimistic, you can check the $isOptimistic property on the record.

const todo = await store.todos.findFirst('some-id')

if (todo.$isOptimistic) {
  console.log('This record is optimistic')
}