Flutter: Upsert data

Perform an UPSERT on the table or view. Depending on the column(s) passed to onConflict, .upsert() allows you to perform the equivalent of .insert() if a row with the corresponding onConflict columns doesn't exist, or if it does exist, perform an alternative action depending on ignoreDuplicates.

• Primary keys must be included in values to use upsert.

Parameters

• values

  (Required)

  The values to upsert with. Pass a Map to upsert a single row or an array to upsert multiple rows.

• onConflict

  (Optional)

  Comma-separated UNIQUE column(s) to specify how duplicate rows are determined. Two rows are duplicates if all the `onConflict` columns are equal.

• ignoreDuplicates

  (Optional)

  If `true`, duplicate rows are ignored. If `false`, duplicate rows are merged with existing rows.

• defaultToNull

  (Optional)

  Make missing fields default to `null`. Otherwise, use the default value for the column. This only applies when inserting new rows, not when merging with existing rows where ignoreDuplicates is set to false. This also only applies when doing bulk upserts.

Examples

Upsert your data

final data = await supabase
  .from('instruments')
  .upsert({ 'id': 1, 'name': 'piano' })
  .select();

Bulk Upsert your data

final data = await supabase
  .from('instruments')
  .upsert([
    { 'id': 1, 'name': 'piano' },
    { 'id': 2, 'name': 'harp' },
  ])
  .select();

Upserting into tables with constraints

final data = await supabase
  .from('users')
  .upsert({ 'id': 42, 'handle': 'saoirse', 'display_name': 'Saoirse' }, { onConflict: 'handle' })
  .select();