org.zalando.sprocwrapper

Annotation Type SProcCall

@Retention(value=RUNTIME)
 @Target(value=METHOD)
 @Inherited
public @interface SProcCall

Author:

jmussler

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
long	adivsoryLockId
String	adivsoryLockName
String	name
boolean	parallel run sproc on multiple shards in parallel?
boolean	readOnly flag this stored procedure call as read only: read only sprocs may run in cases were writing calls would not be allowed (maintenance, migration, ..)
Class<?>	resultMapper
boolean	runOnAllShards whether the stored procedure should be called on all shards --- results are concatenated together.
boolean	searchShards whether the stored procedure should be called on all shards --- return the first result found.
SProcCall.WriteTransaction	shardedWriteTransaction Defines how sharded writes will be handled.
Class<?>	shardStrategy
String	sql
long	timeoutInMilliSeconds
SProcCall.Validate	validate

Element Detail

name

public abstract String name

Default:

""

sql

public abstract String sql

Default:

""

shardStrategy

public abstract Class<?> shardStrategy

Default:

java.lang.Void.class

runOnAllShards

public abstract boolean runOnAllShards

whether the stored procedure should be called on all shards --- results are concatenated together.

Returns:

Default:

false

searchShards

public abstract boolean searchShards

whether the stored procedure should be called on all shards --- return the first result found.

Returns:

Default:

false

parallel

public abstract boolean parallel

run sproc on multiple shards in parallel?

Returns:

Default:

false

readOnly

public abstract boolean readOnly

flag this stored procedure call as read only: read only sprocs may run in cases were writing calls would not be allowed (maintenance, migration, ..)

Returns:

Default:

true

shardedWriteTransaction

public abstract SProcCall.WriteTransaction shardedWriteTransaction

Defines how sharded writes will be handled. If set to SProcCall.WriteTransaction.NONE, no transaction context will be created. If set to SProcCall.WriteTransaction.ONE_PHASE, all errors during the sproc call will be rolled back. If set to SProcCall.WriteTransaction.TWO_PHASE, all errors during sproc call and "prepare transaction" are rolled back. In the last case, the Postgres instance must be configured to manage 2-phase-commits (XA).

Default:

org.zalando.sprocwrapper.SProcCall.WriteTransaction.USE_FROM_SERVICE

resultMapper

public abstract Class<?> resultMapper

Default:

java.lang.Void.class

timeoutInMilliSeconds

public abstract long timeoutInMilliSeconds

Default:

0L

adivsoryLockId

public abstract long adivsoryLockId

Default:

0L

adivsoryLockName

public abstract String adivsoryLockName

Default:

"NO_LOCK"

validate

public abstract SProcCall.Validate validate

Default:

org.zalando.sprocwrapper.SProcCall.Validate.AS_DEFINED_IN_SERVICE