com.lancedb.lance.operation

Class UpdateConfig

java.lang.Object

com.lancedb.lance.operation.UpdateConfig

All Implemented Interfaces:

Operation

public class UpdateConfig
extends Object
implements Operation

Update the dataset configuration. This operation allows updating configuration values, schema metadata, table metadata, and field metadata using the UpdateMap pattern.

Migration Guide from Legacy API

This class has been updated to use the new UpdateMap pattern for all metadata updates. The old API methods are deprecated but still supported for backward compatibility.

Old API (Deprecated):

 UpdateConfig.builder()
     .upsertValues(Map.of("key1", "value1", "key2", "value2"))
     .deleteKeys(List.of("old_key1", "old_key2"))
     .schemaMetadata(Map.of("schema_key", "schema_value"))
     .fieldMetadata(Map.of(0, Map.of("field_key", "field_value")))
     .build();
 

New API (Recommended):

 // For config updates (combines upsert and delete)
 UpdateMap configUpdates = UpdateMap.builder()
     .updates(Map.of("key1", "value1", "key2", "value2", "old_key1", null, "old_key2", null))
     .replace(false)  // false = incremental updates, true = replace all
     .build();

 // For table metadata (new feature!)
 UpdateMap tableMetadata = UpdateMap.builder()
     .updates(Map.of("dataset_description", "My dataset", "version", "1.0"))
     .replace(false)
     .build();

 // For schema metadata
 UpdateMap schemaMetadata = UpdateMap.builder()
     .updates(Map.of("schema_key", "schema_value"))
     .replace(false)
     .build();

 // For field metadata
 UpdateMap field0Metadata = UpdateMap.builder()
     .updates(Map.of("field_key", "field_value"))
     .replace(false)
     .build();

 UpdateConfig.builder()
     .configUpdates(configUpdates)
     .tableMetadataUpdates(tableMetadata)      // NEW: Table-level metadata
     .schemaMetadataUpdates(schemaMetadata)
     .fieldMetadataUpdates(Map.of(0, field0Metadata))
     .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UpdateConfig.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateConfig.Builder	builder()
UpdateMap	configUpdates()
Optional<List<String>>	deleteKeys() Deprecated. Use configUpdates() instead. This method extracts delete keys from the new UpdateMap structure.
Optional<Map<Integer,Map<String,String>>>	fieldMetadata() Deprecated. Use fieldMetadataUpdates() instead. This method converts from the new UpdateMap structure.
Map<Integer,UpdateMap>	fieldMetadataUpdates()
String	name() We use this name to align with the Rust operation enum underlying in JNI.
Optional<Map<String,String>>	schemaMetadata() Deprecated. Use schemaMetadataUpdates() instead. This method extracts updates from the new UpdateMap structure.
UpdateMap	schemaMetadataUpdates()
UpdateMap	tableMetadataUpdates()
String	toString()
Optional<Map<String,String>>	upsertValues() Deprecated. Use configUpdates() instead. This method extracts upsert values from the new UpdateMap structure.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.lancedb.lance.operation.Operation

release

Method Detail

configUpdates

public UpdateMap configUpdates()

tableMetadataUpdates

public UpdateMap tableMetadataUpdates()

schemaMetadataUpdates

public UpdateMap schemaMetadataUpdates()

fieldMetadataUpdates

public Map<Integer,UpdateMap> fieldMetadataUpdates()

upsertValues

@Deprecated
public Optional<Map<String,String>> upsertValues()

Deprecated. Use configUpdates() instead. This method extracts upsert values from the new UpdateMap structure.

Returns:

Optional containing upsert values from config updates, or empty if none

deleteKeys

@Deprecated
public Optional<List<String>> deleteKeys()

Deprecated. Use configUpdates() instead. This method extracts delete keys from the new UpdateMap structure.

Returns:

Optional containing delete keys from config updates, or empty if none

schemaMetadata

@Deprecated
public Optional<Map<String,String>> schemaMetadata()

Deprecated. Use schemaMetadataUpdates() instead. This method extracts updates from the new UpdateMap structure.

Returns:

Optional containing schema metadata updates, or empty if none

fieldMetadata

@Deprecated
public Optional<Map<Integer,Map<String,String>>> fieldMetadata()

Deprecated. Use fieldMetadataUpdates() instead. This method converts from the new UpdateMap structure.

Returns:

Optional containing field metadata updates, or empty if none

name

public String name()

Description copied from interface: Operation

We use this name to align with the Rust operation enum underlying in JNI.

Specified by:

name in interface Operation

Returns:

the name of the operation.

toString

public String toString()

Overrides:

toString in class Object

builder

public static UpdateConfig.Builder builder()