Package org.zalando.sprocwrapper

Annotation Interface SProcCall

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

Author:

jmussler

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SProcCall.AdvisoryLock
static enum	SProcCall.Validate
static enum	SProcCall.WriteTransaction

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	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 Details

name

String name

Default:

""

sql

String sql

Default:

""

shardStrategy

Class<?> shardStrategy

Default:

java.lang.Void.class

runOnAllShards

boolean runOnAllShards

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

Returns:

Default:

false

searchShards

boolean searchShards

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

Returns:

Default:

false

parallel

boolean parallel

run sproc on multiple shards in parallel?

Returns:

Default:

false

readOnly

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

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:

USE_FROM_SERVICE

resultMapper

Class<?> resultMapper

Default:

java.lang.Void.class

timeoutInMilliSeconds

long timeoutInMilliSeconds

Default:

0L

adivsoryLockId

long adivsoryLockId

Default:

0L

adivsoryLockName

String adivsoryLockName

Default:

"NO_LOCK"

validate

SProcCall.Validate validate

Default:

AS_DEFINED_IN_SERVICE