Update a row (Go)

Updates a single row in a table.

If the row does not already exist and the update includes at least one non-null or non-empty value, creates a new row.

For general information about working with tables and rows, see About tables with the Data API (Go).

Ready to write code? See the examples for this method to get started. If you are new to the Data API, check out the quickstart.

Result

Updates the specified row.

If no row matches the specified primary key and the update includes at least one non-null or non-empty value, then a new row is created with the values specified $set values and primary key values. Any omitted or $unset columns are set to null in the new row.

A successful operation does not return anything.

A rare edge case, related to underlying Apache Cassandra® functionality, can cause a row to disappear altogether when all of its columns are set to null.

This happens if the row was previously created from an update operation that had no pre-existing row to modify.

Parameters

Use the UpdateOne method, which belongs to the Table type.

Method signature

func (t *Table) UpdateOne(
  ctx context.Context,
  f TableFilter,
  u TableUpdate,
  opts ...options.TableUpdateOneOption
) error

Name Type Summary

Name	Type	Summary
`ctx`	`context.Context`	The context for the operation.
`f`	`TableFilter`	Describes the full primary key of the row to update. For this method, the filter can only use the `$eq` operator and columns in the primary key.
`u`	`TableUpdate`	Defines the update using Data API operators. For a list of available operators and more examples, see Update operators for tables (Go). You cannot update primary key values. If you need to modify a row’s primary key, delete the row and then insert a new row with the desired primary key values.
`opts`	`…options.TableUpdateOneOption`	Optional. A builder to generate options for this operation. See Methods of the `TableUpdateOneOption` builder for more details.

ctx

context.Context

The context for the operation.

f

TableFilter

Describes the full primary key of the row to update.

For this method, the filter can only use the $eq operator and columns in the primary key.

u

TableUpdate

Defines the update using Data API operators.

For a list of available operators and more examples, see Update operators for tables (Go).

You cannot update primary key values. If you need to modify a row’s primary key, delete the row and then insert a new row with the desired primary key values.

opts

…options.TableUpdateOneOption

Optional. A builder to generate options for this operation. See Methods of the TableUpdateOneOption builder for more details.

Methods of the `TableUpdateOneOption` builder
Method	Summary
`UpdateAPIOptions(v …APIOption)`	Optional. General API options for this operation, including the timeout.

Examples

The following examples demonstrate how to update a row in a table.

Update multiple columns

You can combine multiple operators and properties in a single call. For the full list of operators, see Update operators for tables (Go).

If the row does not already exist and the update includes at least one non-null or non-empty value, creates a new row.

package main

import (
	"context"
	"log"

	"github.com/datastax/astra-db-go/v2/astra"
	"github.com/datastax/astra-db-go/v2/astra/filter"
	"github.com/datastax/astra-db-go/v2/astra/options"
	"github.com/datastax/astra-db-go/v2/astra/update"
)

func main() {
	ctx := context.Background()
	// Get an existing table
	client := astra.NewClient(
		options.API().SetEnvironment(options.EnvironmentHCD),
	)

	database := client.Database(
		"API_ENDPOINT",
		options.API().
			SetUsernamePasswordTokenProvider(
				"USERNAME",
				"PASSWORD",
			).
			SetKeyspace("KEYSPACE_NAME"),
	)

	table := database.Table("TABLE_NAME")

	// Update a row
	err := table.UpdateOne(
		ctx,
		filter.And(
			filter.Eq("title", "Hidden Shadows of the Past"),
			filter.Eq("author", "John Anthony"),
		),
		update.Table().
			Set("rating", 4.5).
			Set("genres", []string{"Fiction", "Drama"}).
			Unset("borrower"),
	)
	if err != nil {
		log.Fatal(err)
	}
}

Update a map column

If the updated map includes non-string keys, you must use a slice of key-value pairs to update the map column.

Otherwise, you can use a slice of key-value pairs or a normal map.

package main

import (
	"context"
	"log"

	"github.com/datastax/astra-db-go/v2/astra"
	"github.com/datastax/astra-db-go/v2/astra/filter"
	"github.com/datastax/astra-db-go/v2/astra/options"
	"github.com/datastax/astra-db-go/v2/astra/update"
)

func main() {
	ctx := context.Background()
	// Get an existing table
	client := astra.NewClient(
		options.API().SetEnvironment(options.EnvironmentHCD),
	)

	database := client.Database(
		"API_ENDPOINT",
		options.API().
			SetUsernamePasswordTokenProvider(
				"USERNAME",
				"PASSWORD",
			).
			SetKeyspace("KEYSPACE_NAME"),
	)

	table := database.Table("TABLE_NAME")

	// Update a row
	err := table.UpdateOne(
		ctx,
		filter.And(
			filter.Eq("title", "Hidden Shadows of the Past"),
			filter.Eq("author", "John Anthony"),
		),
		update.Table().
			// This map has non-string keys,
			// so the update is a slice of key-value pairs
			Set("map_column_int_str", [][]any{{1, "value1"}, {2, "value2"}}).

			// This map does not have non-string keys,
			// so the update does not need to be a slice of key-value
			// pairs
			Set("map_column_str_str", map[string]any{"key1": "value1", "key2": "value2"}),
	)
	if err != nil {
		log.Fatal(err)
	}
}

Append to a list or set column

Use $push to append a single element to a list or set. Use $push with $each to append multiple elements.

package main

import (
	"context"
	"log"

	"github.com/datastax/astra-db-go/v2/astra"
	"github.com/datastax/astra-db-go/v2/astra/filter"
	"github.com/datastax/astra-db-go/v2/astra/options"
	"github.com/datastax/astra-db-go/v2/astra/update"
)

func main() {
	ctx := context.Background()
	// Get an existing table
	client := astra.NewClient(
		options.API().SetEnvironment(options.EnvironmentHCD),
	)

	database := client.Database(
		"API_ENDPOINT",
		options.API().
			SetUsernamePasswordTokenProvider(
				"USERNAME",
				"PASSWORD",
			).
			SetKeyspace("KEYSPACE_NAME"),
	)

	table := database.Table("TABLE_NAME")

	// Update a row
	err := table.UpdateOne(
		ctx,
		filter.And(
			filter.Eq("title", "Hidden Shadows of the Past"),
			filter.Eq("author", "John Anthony"),
		),
		update.Table().
			Push("genres", "SciFi").
			PushEach("topics", "robots", "AI"),
	)
	if err != nil {
		log.Fatal(err)
	}
}

Append to a map column

Use $push to append a single key-value pair to a map. Use $push with $each to append multiple key-value pairs.

If the appended key-value pair has a non-string key, you must represent the key-value pair as a slice. Otherwise, you can either use a slice or a normal map.

package main

import (
	"context"
	"log"

	"github.com/datastax/astra-db-go/v2/astra"
	"github.com/datastax/astra-db-go/v2/astra/filter"
	"github.com/datastax/astra-db-go/v2/astra/options"
	"github.com/datastax/astra-db-go/v2/astra/update"
)

func main() {
	ctx := context.Background()
	// Get an existing table
	client := astra.NewClient(
		options.API().SetEnvironment(options.EnvironmentHCD),
	)

	database := client.Database(
		"API_ENDPOINT",
		options.API().
			SetUsernamePasswordTokenProvider(
				"USERNAME",
				"PASSWORD",
			).
			SetKeyspace("KEYSPACE_NAME"),
	)

	table := database.Table("TABLE_NAME")

	// Update a row
	err := table.UpdateOne(
		ctx,
		filter.And(
			filter.Eq("title", "Hidden Shadows of the Past"),
			filter.Eq("author", "John Anthony"),
		),
		update.Table().
			// This update includes non-string keys,
			// so the update is a key-value pair represented as a slice
			Push("map_column_int_str", []any{1, "value1"}).
			// This update does not include non-string keys,
			// so the update can be a key-value pair represented as a
			// slice or a map
			Push("map_column_str_str", map[string]any{"key1": "value1"}).
			// When using $each, use a slice of key-value pairs for
			// non-string keys
			PushEach("map_column_int_str_2", []any{1, "value1"}, []any{2, "value2"}).

			// When using $each, use a slice of key-value pairs or maps
			// for string keys
			PushEach("map_column_str_str_2", map[string]any{"key1": "value1"}, []any{"key2", "value2"}),
	)
	if err != nil {
		log.Fatal(err)
	}
}

Remove matches from a list or set column

Use $pullAll to remove the specified elements from a list or set.

package main

import (
	"context"
	"log"

	"github.com/datastax/astra-db-go/v2/astra"
	"github.com/datastax/astra-db-go/v2/astra/filter"
	"github.com/datastax/astra-db-go/v2/astra/options"
	"github.com/datastax/astra-db-go/v2/astra/update"
)

func main() {
	ctx := context.Background()
	// Get an existing table
	client := astra.NewClient(
		options.API().SetEnvironment(options.EnvironmentHCD),
	)

	database := client.Database(
		"API_ENDPOINT",
		options.API().
			SetUsernamePasswordTokenProvider(
				"USERNAME",
				"PASSWORD",
			).
			SetKeyspace("KEYSPACE_NAME"),
	)

	table := database.Table("TABLE_NAME")

	// Update a row
	err := table.UpdateOne(
		ctx,
		filter.And(
			filter.Eq("title", "Hidden Shadows of the Past"),
			filter.Eq("author", "John Anthony"),
		),
		update.Table().PullAll("genres", "SciFi", "Romance"),
	)
	if err != nil {
		log.Fatal(err)
	}
}

Remove matches from map column

Use $pullAll to remove entries that match the specified keys from a map column.

package main

import (
	"context"
	"log"

	"github.com/datastax/astra-db-go/v2/astra"
	"github.com/datastax/astra-db-go/v2/astra/filter"
	"github.com/datastax/astra-db-go/v2/astra/options"
	"github.com/datastax/astra-db-go/v2/astra/update"
)

func main() {
	ctx := context.Background()
	// Get an existing table
	client := astra.NewClient(
		options.API().SetEnvironment(options.EnvironmentHCD),
	)

	database := client.Database(
		"API_ENDPOINT",
		options.API().
			SetUsernamePasswordTokenProvider(
				"USERNAME",
				"PASSWORD",
			).
			SetKeyspace("KEYSPACE_NAME"),
	)

	table := database.Table("TABLE_NAME")

	// Update a row
	err := table.UpdateOne(
		ctx,
		filter.And(
			filter.Eq("title", "Hidden Shadows of the Past"),
			filter.Eq("author", "John Anthony"),
		),
		update.Table().PullAll("metadata", "language", "edition"),
	)
	if err != nil {
		log.Fatal(err)
	}
}

Unset columns

To unset a column, you can use the $unset operator, or you can use the $set operator and an empty value. Either operation will delete the value in the specified column.

Unsetting a column produces a tombstone. Excessive tombstones can impact query performance.

package main

import (
	"context"
	"log"

	"github.com/datastax/astra-db-go/v2/astra"
	"github.com/datastax/astra-db-go/v2/astra/filter"
	"github.com/datastax/astra-db-go/v2/astra/options"
	"github.com/datastax/astra-db-go/v2/astra/update"
)

func main() {
	ctx := context.Background()
	// Get an existing table
	client := astra.NewClient(
		options.API().SetEnvironment(options.EnvironmentHCD),
	)

	database := client.Database(
		"API_ENDPOINT",
		options.API().
			SetUsernamePasswordTokenProvider(
				"USERNAME",
				"PASSWORD",
			).
			SetKeyspace("KEYSPACE_NAME"),
	)

	table := database.Table("TABLE_NAME")

	// Update a row
	err := table.UpdateOne(
		ctx,
		filter.And(
			filter.Eq("title", "Hidden Shadows of the Past"),
			filter.Eq("author", "John Anthony"),
		),
		update.Table().Unset("genres"),
	)
	if err != nil {
		log.Fatal(err)
	}
}

Update a user-defined type column

If a column is a user-defined type, you must update the whole value. You can’t update a partial value. In the example below, president and vice_president both use the same user-defined type, which consists of an email and user_name field.

If the value type of a map, list, or set column is a user-defined type, you can only update the whole value, not a partial value, for each entry. The $push, $each, and $pullAll operators work on map, list, and set columns that have a user-defined type as their value type. For examples, see Update a map column, Append to a list or set column, Append to a map column, Remove matches from a list or set column, and Remove matches from map column.

package main

import (
	"context"
	"log"

	"github.com/datastax/astra-db-go/v2/astra"
	"github.com/datastax/astra-db-go/v2/astra/filter"
	"github.com/datastax/astra-db-go/v2/astra/options"
	"github.com/datastax/astra-db-go/v2/astra/update"
)

func main() {
	ctx := context.Background()
	// Get an existing table
	client := astra.NewClient(
		options.API().SetEnvironment(options.EnvironmentHCD),
	)

	database := client.Database(
		"API_ENDPOINT",
		options.API().
			SetUsernamePasswordTokenProvider(
				"USERNAME",
				"PASSWORD",
			).
			SetKeyspace("KEYSPACE_NAME"),
	)

	table := database.Table("TABLE_NAME")

	// Update a row
	err := table.UpdateOne(
		ctx,
		filter.Eq("title", "Chemistry Club"),
		update.Table().Set("president", map[string]any{
			"email":     "lisa@example.com",
			"user_name": "lisa_m"}).Set("vice_president", map[string]any{
			"email":     "tanya@example.com",
			"user_name": "tanya_o"}),
	)
	if err != nil {
		log.Fatal(err)
	}
}

Client reference

For more information, see the client reference.

Update a row (Go)

Result

Parameters

Examples

Update multiple columns

Update a map column

Append to a list or set column

Append to a map column

Remove matches from a list or set column

Remove matches from map column

Unset columns

Update a user-defined type column

Client reference

Was this helpful?

Give Feedback