Top Description Fields Constructors Methods
org.postgresql.core

public Class NativeQuery

extends Object
Class Inheritance
Imports
org.checkerframework.checker.nullness.qual.Nullable

Represents a query that is ready for execution by backend. The main difference from JDBC is ? are replaced with $1, $2, etc.

Field Summary

Modifier and TypeField and Description
private static final String[]
public final int[]
public final SqlCommand
public final boolean
public final String
private static final int[]

Constructor Summary

AccessConstructor and Description
public
NativeQuery(String nativeSql, SqlCommand dml)

public
NativeQuery(String nativeSql, @Nullable int[] bindPositions, boolean multiStatement, SqlCommand dml)

Method Summary

Modifier and TypeMethod and Description
public static StringBuilder
public static String

Returns:

bind variable name
bindName
(int
index of a bind variable
index
)

Returns $1, $2, etc names of bind variables used by backend.

public static int

Returns:

int total character length for $xyz kind of binds
calculateBindLength
(int
total number of parameters in a query
bindCount
)

Calculate the text length required for the given number of bind variables including dollars.

public SqlCommand
public String

Returns:

a human-readable representation of this query
toString
(@Nullable ParameterList
a ParameterList returned by this Query's Query#createParameterList method, or null to leave the parameter placeholders unsubstituted.
parameters
)

Stringize this query to a human-readable form, substituting particular parameter values for parameter placeholders.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

BIND_NAMESback to summary
private static final String[] BIND_NAMES
bindPositionsback to summary
public final int[] bindPositions
commandback to summary
public final SqlCommand command
multiStatementback to summary
public final boolean multiStatement
nativeSqlback to summary
public final String nativeSql
NO_BINDSback to summary
private static final int[] NO_BINDS

Constructor Detail

NativeQueryback to summary
public NativeQuery(String nativeSql, SqlCommand dml)
NativeQueryback to summary
public NativeQuery(String nativeSql, @Nullable int[] bindPositions, boolean multiStatement, SqlCommand dml)

Method Detail

appendBindNameback to summary
public static StringBuilder appendBindName(StringBuilder sb, int index)
bindNameback to summary
public static String bindName(int index)

Returns $1, $2, etc names of bind variables used by backend.

Parameters
index:int

index of a bind variable

Returns:String

bind variable name

calculateBindLengthback to summary
public static int calculateBindLength(int bindCount)

Calculate the text length required for the given number of bind variables including dollars. Do this to avoid repeated calls to AbstractStringBuilder.expandCapacity(...) and Arrays.copyOf

Parameters
bindCount:int

total number of parameters in a query

Returns:int

int total character length for $xyz kind of binds

getCommandback to summary
public SqlCommand getCommand()
toStringback to summary
public String toString(@Nullable ParameterList parameters)

Stringize this query to a human-readable form, substituting particular parameter values for parameter placeholders.

Parameters
parameters:@Nullable ParameterList

a ParameterList returned by this Query's Query#createParameterList method, or null to leave the parameter placeholders unsubstituted.

Returns:String

a human-readable representation of this query