com.lancedb.lance.merge

Enum MergeInsertParams.WhenMatched

java.lang.Object

java.lang.Enum<MergeInsertParams.WhenMatched>

com.lancedb.lance.merge.MergeInsertParams.WhenMatched

All Implemented Interfaces:

Serializable, Comparable<MergeInsertParams.WhenMatched>

Enclosing class:

MergeInsertParams

public static enum MergeInsertParams.WhenMatched
extends Enum<MergeInsertParams.WhenMatched>

Enum Constant Summary

Enum Constants

Enum Constant and Description
DoNothing The row is kept unchanged.
Fail The operation will fail if a match is found between the source and target table.
UpdateAll The row is deleted from the target table and a new row is inserted based on the source table.
UpdateIf The row is updated (similar to UpdateAll) only for rows where the expression evaluates to true.

Method Summary

Modifier and Type	Method and Description
static MergeInsertParams.WhenMatched	valueOf(String name) Returns the enum constant of this type with the specified name.
static MergeInsertParams.WhenMatched[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UpdateAll

public static final MergeInsertParams.WhenMatched UpdateAll

The row is deleted from the target table and a new row is inserted based on the source table. This can be used to achieve upsert behavior.

DoNothing

public static final MergeInsertParams.WhenMatched DoNothing

The row is kept unchanged. This can be used to achieve find-or-create behavior.

UpdateIf

public static final MergeInsertParams.WhenMatched UpdateIf

The row is updated (similar to UpdateAll) only for rows where the expression evaluates to true.

Fail

public static final MergeInsertParams.WhenMatched Fail

The operation will fail if a match is found between the source and target table. This can be used to ensure that no existing rows are overwritten or modified after inserted.

Method Detail

values

public static MergeInsertParams.WhenMatched[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MergeInsertParams.WhenMatched c : MergeInsertParams.WhenMatched.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MergeInsertParams.WhenMatched valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null