Modifier and Type	Class and Description
private static class	NamedParameterUtils.ExpandedQuery Expanded query that allows binding of parameters using parameter names that were used to expand the query.
pack-priv static class	NamedParameterUtils.NamedParameters Holder for bind markers progress.
private static class	NamedParameterUtils.ParameterHolder

Modifier and Type	Field and Description
private static final String	PARAMETER_SEPARATORS Set of characters that qualify as parameter separators, indicating that a parameter name in an SQL String has ended.
private static final boolean[]	separatorIndex An index with separator flags per character code.
private static final String[]	START_SKIP Set of characters that qualify as comment or quotes starting characters.
private static final String[]	STOP_SKIP Set of characters that at are the corresponding comment or quotes ending characters.

Access	Constructor and Description
pack-priv	NamedParameterUtils()

Method Summary

Modifier and Type	Method and Description
private static int	addNamedParameter(List<NamedParameterUtils.ParameterHolder> parameterList, int totalParameterCount, int escapes, int i, int j, String parameter)
private static int	addNewNamedParameter(Set<String> namedParameters, int namedParameterCount, String parameter)
private static boolean	isParameterSeparator(char c) Determine whether a parameter name ends at the current position, that is, whether the given character qualifies as a separator.
public static ParsedSql	Returns: the parsed statement, represented as `ParsedSql` instance parseSqlStatement(String the SQL statement sql) Parse the SQL statement and locate any placeholders or named parameters.
private static int	Returns: next position to process after any comments or quotes are skipped skipCommentsAndQuotes(char[] character array containing SQL statement statement, int current position of statement position) Skip over comments and quoted names present in an SQL statement.
public static PreparedOperation<String>	Returns: the expanded query that accepts bind parameters and allows for execution without further translation substituteNamedParameters(ParsedSql the parsed representation of the SQL statement parsedSql, BindMarkersFactory the bind marker factory. bindMarkersFactory, BindParameterSource the source for named parameters paramSource) Parse the SQL statement and locate any placeholders or named parameters.
public static PreparedOperation<String>	Returns: the expanded query that accepts bind parameters and allows for execution without further translation substituteNamedParameters(String the SQL statement sql, BindMarkersFactory the bind marker factory bindMarkersFactory, BindParameterSource the source for named parameters paramSource) Parse the SQL statement and locate any placeholders or named parameters.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

PARAMETER_SEPARATORS	back to summary
private static final String PARAMETER_SEPARATORS Set of characters that qualify as parameter separators, indicating that a parameter name in an SQL String has ended.

separatorIndex	back to summary
private static final boolean[] separatorIndex An index with separator flags per character code. Technically only needed between 34 and 124 at this point.

START_SKIP	back to summary
private static final String[] START_SKIP Set of characters that qualify as comment or quotes starting characters.

STOP_SKIP	back to summary
private static final String[] STOP_SKIP Set of characters that at are the corresponding comment or quotes ending characters.

NamedParameterUtils	back to summary
pack-priv NamedParameterUtils()

Method Detail

addNamedParameter	back to summary
private static int addNamedParameter(List<NamedParameterUtils.ParameterHolder> parameterList, int totalParameterCount, int escapes, int i, int j, String parameter)

addNewNamedParameter	back to summary
private static int addNewNamedParameter(Set<String> namedParameters, int namedParameterCount, String parameter)

isParameterSeparator	back to summary
private static boolean isParameterSeparator(char c) Determine whether a parameter name ends at the current position, that is, whether the given character qualifies as a separator.

parseSqlStatement back to summary

parseSqlStatement	back to summary
public static ParsedSql parseSqlStatement(String sql) Parse the SQL statement and locate any placeholders or named parameters. Named parameters are substituted for an R2DBC placeholder. Parameters sql:String the SQL statement Returns:ParsedSql the parsed statement, represented as `ParsedSql` instance

public static ParsedSql parseSqlStatement(String sql)

Parse the SQL statement and locate any placeholders or named parameters. Named parameters are substituted for an R2DBC placeholder.

Parameters

sql:String: the SQL statement

Returns:ParsedSql

the parsed statement, represented as ParsedSql instance

skipCommentsAndQuotes	back to summary
private static int skipCommentsAndQuotes(char[] statement, int position) Skip over comments and quoted names present in an SQL statement. Parameters statement:char[] character array containing SQL statement position:int current position of statement Returns:int next position to process after any comments or quotes are skipped

skipCommentsAndQuotes

back to summary

private static int skipCommentsAndQuotes(char[] statement, int position)

Skip over comments and quoted names present in an SQL statement.

Parameters

statement:char[]: character array containing SQL statement
position:int: current position of statement

Returns:int

next position to process after any comments or quotes are skipped

substituteNamedParameters back to summary

substituteNamedParameters	back to summary
public static PreparedOperation<String> substituteNamedParameters(ParsedSql parsedSql, BindMarkersFactory bindMarkersFactory, BindParameterSource paramSource) Parse the SQL statement and locate any placeholders or named parameters. Named parameters are substituted for an R2DBC placeholder, and any select list is expanded to the required number of placeholders. Select lists may contain an array of objects, and in that case the placeholders will be grouped and enclosed with parentheses. This allows for the use of "expression lists" in the SQL statement like: `select id, name, state from table where (name, age) in (('John', 35), ('Ann', 50))` The parameter values passed in are used to determine the number of placeholders to be used for a select list. Select lists should be limited to 100 or fewer elements. A larger number of elements is not guaranteed to be supported by the database and is strictly vendor-dependent. Parameters parsedSql:ParsedSql the parsed representation of the SQL statement bindMarkersFactory:BindMarkersFactory the bind marker factory. paramSource:BindParameterSource the source for named parameters Returns:PreparedOperation<String> the expanded query that accepts bind parameters and allows for execution without further translation See Also `parseSqlStatement`

public static PreparedOperation<String> substituteNamedParameters(ParsedSql parsedSql, BindMarkersFactory bindMarkersFactory, BindParameterSource paramSource)

Parse the SQL statement and locate any placeholders or named parameters. Named parameters are substituted for an R2DBC placeholder, and any select list is expanded to the required number of placeholders. Select lists may contain an array of objects, and in that case the placeholders will be grouped and enclosed with parentheses. This allows for the use of "expression lists" in the SQL statement like: select id, name, state from table where (name, age) in (('John', 35), ('Ann', 50))

The parameter values passed in are used to determine the number of placeholders to be used for a select list. Select lists should be limited to 100 or fewer elements. A larger number of elements is not guaranteed to be supported by the database and is strictly vendor-dependent.

Parameters

parsedSql:ParsedSql: the parsed representation of the SQL statement
bindMarkersFactory:BindMarkersFactory: the bind marker factory.
paramSource:BindParameterSource: the source for named parameters

Returns:PreparedOperation<String>

the expanded query that accepts bind parameters and allows for execution without further translation

See Also

parseSqlStatement

substituteNamedParameters	back to summary
public static PreparedOperation<String> substituteNamedParameters(String sql, BindMarkersFactory bindMarkersFactory, BindParameterSource paramSource) Parse the SQL statement and locate any placeholders or named parameters. Named parameters are substituted for a native placeholder and any select list is expanded to the required number of placeholders. Parameters sql:String the SQL statement bindMarkersFactory:BindMarkersFactory the bind marker factory paramSource:BindParameterSource the source for named parameters Returns:PreparedOperation<String> the expanded query that accepts bind parameters and allows for execution without further translation

substituteNamedParameters

back to summary

public static PreparedOperation<String> substituteNamedParameters(String sql, BindMarkersFactory bindMarkersFactory, BindParameterSource paramSource)

Parse the SQL statement and locate any placeholders or named parameters. Named parameters are substituted for a native placeholder and any select list is expanded to the required number of placeholders.

Parameters

sql:String: the SQL statement
bindMarkersFactory:BindMarkersFactory: the bind marker factory
paramSource:BindParameterSource: the source for named parameters

Returns:PreparedOperation<String>

the expanded query that accepts bind parameters and allows for execution without further translation

org.springframework.r2dbc.core back to summary

private Class NamedParameterUtils.ExpandedQuery

Class Inheritance

extends Object
implements PreparedOperation<String>

java.lang.Object
org.springframework.r2dbc.core.NamedParameterUtils.ExpandedQuery

All Implemented Interfaces

org.springframework.r2dbc.core.PreparedOperation, org.springframework.r2dbc.core.QueryOperation, java.util.function.Supplier

Expanded query that allows binding of parameters using parameter names that were used to expand the query. Binding unrolls Collections and nested arrays.

Field Summary

Modifier and Type	Field and Description
private final String	expandedSql
private final NamedParameterUtils.NamedParameters	parameters
private final BindParameterSource	parameterSource

Constructor Summary

Access	Constructor and Description
pack-priv	ExpandedQuery(String expandedSql, NamedParameterUtils.NamedParameters parameters, BindParameterSource parameterSource)

Method Summary

Modifier and Type	Method and Description
public void	bind(BindTarget target, String identifier, Parameter parameter)
private void	bind(BindTarget target, Iterator<BindMarker> markers, Object valueToBind)
public void	bindNull(BindTarget target, String identifier, Parameter parameter)
public void	bindTo(BindTarget the target to apply bindings to target) Implements org.springframework.r2dbc.core.PreparedOperation.bindTo. Apply bindings to the supplied `BindTarget`.
pack-priv List<BindMarker>	getBindMarkers(String identifier)
public String	getSource() Implements org.springframework.r2dbc.core.PreparedOperation.getSource. Get the underlying query source.
public String	toQuery() Implements org.springframework.r2dbc.core.QueryOperation.toQuery. Return the string-representation of this operation to be used with `io.r2dbc.spi.Statement` creation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

expandedSql	back to summary
private final String expandedSql

parameters	back to summary
private final NamedParameterUtils.NamedParameters parameters

parameterSource	back to summary
private final BindParameterSource parameterSource

Constructor Detail

ExpandedQuery	back to summary
pack-priv ExpandedQuery(String expandedSql, NamedParameterUtils.NamedParameters parameters, BindParameterSource parameterSource)

Method Detail

bind	back to summary
public void bind(BindTarget target, String identifier, Parameter parameter) Annotations @SuppressWarnings:rawtypes, unchecked

bind	back to summary
private void bind(BindTarget target, Iterator<BindMarker> markers, Object valueToBind)

bindNull	back to summary
public void bindNull(BindTarget target, String identifier, Parameter parameter)

bindTo back to summary

bindTo	back to summary
public void bindTo(BindTarget target) Implements org.springframework.r2dbc.core.PreparedOperation.bindTo. Doc from org.springframework.r2dbc.core.PreparedOperation.bindTo. Apply bindings to the supplied `BindTarget`. Parameters target:BindTarget the target to apply bindings to Annotations @Override

public void bindTo(BindTarget target)

Implements org.springframework.r2dbc.core.PreparedOperation.bindTo.

Doc from org.springframework.r2dbc.core.PreparedOperation.bindTo.

Apply bindings to the supplied BindTarget.

Parameters

target:BindTarget: the target to apply bindings to

Annotations

@Override

getBindMarkers	back to summary
pack-priv List<BindMarker> getBindMarkers(String identifier) Annotations @Nullable

getSource	back to summary
public String getSource() Implements org.springframework.r2dbc.core.PreparedOperation.getSource. Doc from org.springframework.r2dbc.core.PreparedOperation.getSource. Get the underlying query source. Returns:String the query source, such as a statement/criteria object Annotations @Override

getSource

back to summary

public String getSource()

Implements org.springframework.r2dbc.core.PreparedOperation.getSource.

Doc from org.springframework.r2dbc.core.PreparedOperation.getSource.

Get the underlying query source.

Returns:String

the query source, such as a statement/criteria object

Annotations

@Override

toQuery back to summary

toQuery	back to summary
public String toQuery() Implements org.springframework.r2dbc.core.QueryOperation.toQuery. Doc from org.springframework.r2dbc.core.QueryOperation.toQuery. Return the string-representation of this operation to be used with `io.r2dbc.spi.Statement` creation. Returns:String the operation as SQL string Annotations @Override

public String toQuery()

Implements org.springframework.r2dbc.core.QueryOperation.toQuery.

Doc from org.springframework.r2dbc.core.QueryOperation.toQuery.

Return the string-representation of this operation to be used with io.r2dbc.spi.Statement creation.

Returns:String

the operation as SQL string

Annotations

@Override

org.springframework.r2dbc.core back to summary

pack-priv Class NamedParameterUtils.NamedParameters

Class Inheritance

extends Object

java.lang.Object
org.springframework.r2dbc.core.NamedParameterUtils.NamedParameters

Holder for bind markers progress.

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv class	NamedParameterUtils.NamedParameters.NamedParameter

Field Summary

Modifier and Type	Field and Description
private final BindMarkers	bindMarkers
private final boolean	identifiable
private final Map<String, List<NamedParameterUtils.NamedParameters.NamedParameter>>	references

Constructor Summary

Access	Constructor and Description
pack-priv	NamedParameters(BindMarkersFactory factory)

Method Summary

Modifier and Type	Method and Description
pack-priv List<NamedParameterUtils.NamedParameters.NamedParameter>	getMarker(String name)
pack-priv NamedParameterUtils.NamedParameters.NamedParameter	Returns: the named parameter getOrCreate(String the parameter name namedParameter) Get the `NamedParameter` identified by `namedParameter`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

bindMarkers	back to summary
private final BindMarkers bindMarkers

identifiable	back to summary
private final boolean identifiable

references	back to summary
private final Map<String, List<NamedParameterUtils.NamedParameters.NamedParameter>> references

Constructor Detail

NamedParameters	back to summary
pack-priv NamedParameters(BindMarkersFactory factory)

Method Detail

getMarker	back to summary
pack-priv List<NamedParameterUtils.NamedParameters.NamedParameter> getMarker(String name) Annotations @Nullable

getOrCreate back to summary

getOrCreate	back to summary
pack-priv NamedParameterUtils.NamedParameters.NamedParameter getOrCreate(String namedParameter) Get the `NamedParameter` identified by `namedParameter`. Parameter objects get created if they do not yet exist. Parameters namedParameter:String the parameter name Returns:NamedParameterUtils.NamedParameters.NamedParameter the named parameter

pack-priv NamedParameterUtils.NamedParameters.NamedParameter getOrCreate(String namedParameter)

Get the NamedParameter identified by namedParameter. Parameter objects get created if they do not yet exist.

Parameters

namedParameter:String: the parameter name

Returns:NamedParameterUtils.NamedParameters.NamedParameter

the named parameter

org.springframework.r2dbc.core back to summary

pack-priv Class NamedParameterUtils.NamedParameters.NamedParameter

Class Inheritance

extends Object

java.lang.Object
org.springframework.r2dbc.core.NamedParameterUtils.NamedParameters.NamedParameter

Field Summary

Modifier and Type	Field and Description
private final String	namedParameter
private final List<BindMarker>	placeholders

Constructor Summary

Access	Constructor and Description
pack-priv	NamedParameter(String namedParameter)

Method Summary

Modifier and Type	Method and Description
pack-priv String	Returns: the placeholder to be used in the SQL statement addPlaceholder() Create a placeholder to translate a single value into a bindable parameter.
pack-priv String	getPlaceholder()
pack-priv String	getPlaceholder(int counter)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

namedParameter	back to summary
private final String namedParameter

placeholders	back to summary
private final List<BindMarker> placeholders

Constructor Detail

NamedParameter	back to summary
pack-priv NamedParameter(String namedParameter)

Method Detail

addPlaceholder	back to summary
pack-priv String addPlaceholder() Create a placeholder to translate a single value into a bindable parameter. Can be called multiple times to create placeholders for array/collections. Returns:String the placeholder to be used in the SQL statement

addPlaceholder

back to summary

pack-priv String addPlaceholder()

Create a placeholder to translate a single value into a bindable parameter.

Can be called multiple times to create placeholders for array/collections.

Returns:String: the placeholder to be used in the SQL statement

getPlaceholder	back to summary
pack-priv String getPlaceholder()

getPlaceholder	back to summary
pack-priv String getPlaceholder(int counter)

org.springframework.r2dbc.core back to summary

private Class NamedParameterUtils.ParameterHolder

Class Inheritance

extends Object

java.lang.Object
org.springframework.r2dbc.core.NamedParameterUtils.ParameterHolder

Field Summary

Modifier and Type	Field and Description
private final int	endIndex
private final String	parameterName
private final int	startIndex

Constructor Summary

Access	Constructor and Description
pack-priv	ParameterHolder(String parameterName, int startIndex, int endIndex)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
pack-priv int	getEndIndex()
pack-priv String	getParameterName()
pack-priv int	getStartIndex()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

endIndex	back to summary
private final int endIndex

parameterName	back to summary
private final String parameterName

startIndex	back to summary
private final int startIndex

Constructor Detail

ParameterHolder	back to summary
pack-priv ParameterHolder(String parameterName, int startIndex, int endIndex)

Method Detail

equals back to summary

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getEndIndex	back to summary
pack-priv int getEndIndex()

getParameterName	back to summary
pack-priv String getParameterName()

getStartIndex	back to summary
pack-priv int getStartIndex()

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

pack-priv abstract Class NamedParameterUtils

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class NamedParameterUtils.ExpandedQuery

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class NamedParameterUtils.NamedParameters

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class NamedParameterUtils.NamedParameters.NamedParameter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class NamedParameterUtils.ParameterHolder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail