com.lancedb.lance.merge

Class MergeInsertParams

java.lang.Object

com.lancedb.lance.merge.MergeInsertParams

public class MergeInsertParams
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MergeInsertParams.WhenMatched
static class	MergeInsertParams.WhenNotMatched
static class	MergeInsertParams.WhenNotMatchedBySource

Constructor Summary

Constructors

Constructor and Description
MergeInsertParams(List<String> on)

Method Summary

Modifier and Type	Method and Description
int	conflictRetries()
List<String>	on()
long	retryTimeoutMs()
boolean	skipAutoCleanup()
String	toString()
MergeInsertParams.WhenMatched	whenMatched()
Optional<String>	whenMatchedUpdateExpr()
String	whenMatchedValue()
MergeInsertParams.WhenNotMatched	whenNotMatched()
MergeInsertParams.WhenNotMatchedBySource	whenNotMatchedBySource()
Optional<String>	whenNotMatchedBySourceDeleteExpr()
Optional<ByteBuffer>	whenNotMatchedBySourceDeleteSubstraitExpr()
String	whenNotMatchedBySourceValue()
String	whenNotMatchedValue()
MergeInsertParams	withConflictRetries(int retries) Set number of times to retry the operation if there is contention.
MergeInsertParams	withMatchedDoNothing() Specify that when a row in the source table matches a row in the target table, the row in the target table is kept unchanged.
MergeInsertParams	withMatchedFail() Specify that when a row in the source table matches a row in the target table, the entire merge operation will fail with an error.
MergeInsertParams	withMatchedUpdateAll() Specify that when a row in the source table matches a row in the target table, the row is deleted from the target table and the matched row based on the source table is inserted.
MergeInsertParams	withMatchedUpdateIf(String expr) Specify that when a row in the source table matches a row in the target table and the expression evaluates to true, the row in the target table is updated by the matched row from the source table.
MergeInsertParams	withNotMatched(MergeInsertParams.WhenNotMatched whenNotMatched) Specify what should happen when a source row has no match in the target.
MergeInsertParams	withNotMatchedBySourceDelete() Specify that when a target row has no match in the source, the row is deleted from the target table.
MergeInsertParams	withNotMatchedBySourceDeleteIf(String expr) Specify that when a target row has no match in the source and the expression evaluates to true, the row is deleted from the target table.
MergeInsertParams	withNotMatchedBySourceDeleteSubstraitIf(ByteBuffer expr) Specify that when a target row has no match in the source and the expression evaluates to true, the row is deleted from the target table.
MergeInsertParams	withNotMatchedBySourceKeep() Specify that when a target row has no match in the source, the row is kept in the target table.
MergeInsertParams	withRetryTimeoutMs(long timeoutMs) Set the timeout in milliseconds used to limit retries.
MergeInsertParams	withSkipAutoCleanup(boolean skipAutoCleanup) If true, skip auto cleanup during commits.

Methods inherited from class java.lang.Object

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

Constructor Detail

MergeInsertParams

public MergeInsertParams(List<String> on)

Method Detail

withMatchedUpdateAll

public MergeInsertParams withMatchedUpdateAll()

Specify that when a row in the source table matches a row in the target table, the row is deleted from the target table and the matched row based on the source table is inserted.

This can be used to achieve upsert behavior.

Returns:

This MergeInsertParams instance

withMatchedDoNothing

public MergeInsertParams withMatchedDoNothing()

Specify that when a row in the source table matches a row in the target table, the row in the target table is kept unchanged.

This can be used to achieve find-or-create behavior.

Returns:

This MergeInsertParams instance

withMatchedUpdateIf

public MergeInsertParams withMatchedUpdateIf(String expr)

Specify that when a row in the source table matches a row in the target table and the expression evaluates to true, the row in the target table is updated by the matched row from the source table.

This can be used to achieve upsert behavior.

The expression can reference source tables' columns with source. and target tables' columns with target. This is an example: source.column1 = target.column1 AND source.column2 = target.column2

Parameters:

expr - The expression to evaluate on the rows in the source table and target table.

Returns:

This MergeInsertParams instance

withMatchedFail

public MergeInsertParams withMatchedFail()

Specify that when a row in the source table matches a row in the target table, the entire merge operation will fail with an error.

This can be used to ensure that no existing rows are overwritten or modified after inserted.

Returns:

This MergeInsertParams instance

withNotMatched

public MergeInsertParams withNotMatched(MergeInsertParams.WhenNotMatched whenNotMatched)

Specify what should happen when a source row has no match in the target.

Parameters:

whenNotMatched - The action to take when a source row has no match in the target.

Returns:

This MergeInsertParams instance

withNotMatchedBySourceKeep

public MergeInsertParams withNotMatchedBySourceKeep()

Specify that when a target row has no match in the source, the row is kept in the target table.

Returns:

This MergeInsertParams instance

withNotMatchedBySourceDelete

public MergeInsertParams withNotMatchedBySourceDelete()

Specify that when a target row has no match in the source, the row is deleted from the target table.

Returns:

This MergeInsertParams instance

withNotMatchedBySourceDeleteIf

public MergeInsertParams withNotMatchedBySourceDeleteIf(String expr)

Specify that when a target row has no match in the source and the expression evaluates to true, the row is deleted from the target table.

Parameters:

expr - The sql expression to evaluate on the rows in the target table.

Returns:

This MergeInsertParams instance

withNotMatchedBySourceDeleteSubstraitIf

public MergeInsertParams withNotMatchedBySourceDeleteSubstraitIf(ByteBuffer expr)

Specify that when a target row has no match in the source and the expression evaluates to true, the row is deleted from the target table.

Parameters:

expr - The substrait expression to evaluate on the rows in the target table.

Returns:

This MergeInsertParams instance

withConflictRetries

public MergeInsertParams withConflictRetries(int retries)

Set number of times to retry the operation if there is contention.

If this is set greater than 0, then the operation will keep a copy of the input data either in memory or on disk (depending on the size of the data) and will retry the operation if there is contention.

Default is 10.

Parameters:

retries - Number of times to retry the operation if there is contention.

Returns:

This MergeInsertParams instance

withRetryTimeoutMs

public MergeInsertParams withRetryTimeoutMs(long timeoutMs)

Set the timeout in milliseconds used to limit retries.

This is the maximum time to spend on the operation before giving up. At least one attempt will be made, regardless of how long it takes to complete. Subsequent attempts will be cancelled once this timeout is reached. If the timeout has been reached during the first attempt, the operation will be cancelled immediately.

Default is 30000.

Parameters:

timeoutMs - Timeout in milliseconds used to limit retries.

Returns:

This MergeInsertParams instance

withSkipAutoCleanup

public MergeInsertParams withSkipAutoCleanup(boolean skipAutoCleanup)

If true, skip auto cleanup during commits. This should be set to true for high frequency writes to improve performance. This is also useful if the writer does not have delete permissions and the clean up would just try and log a failure anyway.

Parameters:

skipAutoCleanup - Whether to skip auto cleanup during commits.

Returns:

This MergeInsertParams instance

on

public List<String> on()

whenMatched

public MergeInsertParams.WhenMatched whenMatched()

whenMatchedValue

public String whenMatchedValue()

whenMatchedUpdateExpr

public Optional<String> whenMatchedUpdateExpr()

whenNotMatched

public MergeInsertParams.WhenNotMatched whenNotMatched()

whenNotMatchedValue

public String whenNotMatchedValue()

whenNotMatchedBySource

public MergeInsertParams.WhenNotMatchedBySource whenNotMatchedBySource()

whenNotMatchedBySourceValue

public String whenNotMatchedBySourceValue()

whenNotMatchedBySourceDeleteExpr

public Optional<String> whenNotMatchedBySourceDeleteExpr()

whenNotMatchedBySourceDeleteSubstraitExpr

public Optional<ByteBuffer> whenNotMatchedBySourceDeleteSubstraitExpr()

conflictRetries

public int conflictRetries()

retryTimeoutMs

public long retryTimeoutMs()

skipAutoCleanup

public boolean skipAutoCleanup()

toString

public String toString()

Overrides:

toString in class Object