Package org.postgresql.core.v3
Class SimpleParameterList
java.lang.Object
org.postgresql.core.v3.SimpleParameterList
- All Implemented Interfaces:
ParameterList
,V3ParameterList
Parameter list for a single-statement V3 query.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final byte
private final byte[][]
private final byte[]
private static final byte
private static final byte
private static final Object
Marker object representing NULL; this distinguishes "parameter never set" from "parameter set to null".private static final byte
private final int[]
private final Object[]
private int
private static final byte
private final TypeTransferModeRegistry
-
Constructor Summary
ConstructorsConstructorDescriptionSimpleParameterList
(int paramCount, TypeTransferModeRegistry transferModeRegistry) -
Method Summary
Modifier and TypeMethodDescriptionvoid
appendAll
(ParameterList list) Use this operation to append more parameters to the current list.private void
void
Ensure that all parameters in this list have been assigned values.void
clear()
Unbind all parameter values bound in this list.void
Convert any function output parameters to the correct type (void) and set an ignorable value for it.copy()
Perform a shallow copy of this ParameterList, returning a new instance (still suitable for passing to the owning Query).private byte
direction
(int index) byte[][]
Return the encoding for each parameter.byte[]
getFlags()
Return the flags for each parameter.int
Get the number of IN parameters in this list.int
Get the number of OUT parameters in this list.int
Get the number of parameters in this list.int[]
Return the parameter type information.Return a list of the SimpleParameterList objects that make up this parameter list.(package private) int
getTypeOID
(int index) int[]
Return the oids of the parameters in this list.(package private) int
getV3Length
(int index) Object[]
Returns the bound parameter values.(package private) boolean
(package private) boolean
isBinary
(int index) (package private) boolean
isNull
(int index) void
registerOutParameter
(int index, int sqlType) void
setBinaryParameter
(int index, byte[] value, int oid) Binds given byte[] value to a parameter.void
setBytea
(int index, byte[] data, int offset, int length) Binds a binary bytea value stored as a bytearray to a parameter.void
setBytea
(int index, InputStream stream) Binds a binary bytea value stored as an InputStream.void
setBytea
(int index, InputStream stream, int length) Binds a binary bytea value stored as an InputStream.void
setBytea
(int index, ByteStreamWriter writer) Binds a binary bytea value stored as a ByteStreamWriter.void
setIntParameter
(int index, int value) Binds an integer value to a parameter.void
setLiteralParameter
(int index, String value, int oid) Binds a String value that is an unquoted literal to the server's query parser (for example, a bare integer) to a parameter.void
setNull
(int index, int oid) Binds a SQL NULL value to a parameter.(package private) void
setResolvedType
(int index, int oid) void
setStringParameter
(int index, String value, int oid) Binds a String value that needs to be quoted for the server's parser to understand (for example, a timestamp) to a parameter.void
setText
(int index, InputStream stream) Binds a text value stored as an InputStream that is a valid UTF-8 byte stream.private static void
streamBytea
(PGStream pgStream, ByteStreamWriter writer) private static void
streamBytea
(PGStream pgStream, StreamWrapper wrapper) toString()
Useful implementation of toString.toString
(int index, boolean standardConformingStrings) Return a human-readable representation of a particular parameter in this ParameterList.(package private) void
writeV3Value
(int index, PGStream pgStream)
-
Field Details
-
IN
private static final byte IN- See Also:
-
OUT
private static final byte OUT- See Also:
-
INOUT
private static final byte INOUT- See Also:
-
TEXT
private static final byte TEXT- See Also:
-
BINARY
private static final byte BINARY- See Also:
-
paramValues
-
paramTypes
private final int[] paramTypes -
flags
private final byte[] flags -
encoded
private final byte[][] encoded -
transferModeRegistry
-
NULL_OBJECT
Marker object representing NULL; this distinguishes "parameter never set" from "parameter set to null". -
pos
private int pos
-
-
Constructor Details
-
SimpleParameterList
SimpleParameterList(int paramCount, TypeTransferModeRegistry transferModeRegistry)
-
-
Method Details
-
registerOutParameter
- Specified by:
registerOutParameter
in interfaceParameterList
- Throws:
SQLException
-
bind
- Throws:
SQLException
-
getParameterCount
public int getParameterCount()Description copied from interface:ParameterList
Get the number of parameters in this list. This value never changes for a particular instance, and might be zero.- Specified by:
getParameterCount
in interfaceParameterList
- Returns:
- the number of parameters in this list.
-
getOutParameterCount
public int getOutParameterCount()Description copied from interface:ParameterList
Get the number of OUT parameters in this list.- Specified by:
getOutParameterCount
in interfaceParameterList
- Returns:
- the number of OUT parameters in this list
-
getInParameterCount
public int getInParameterCount()Description copied from interface:ParameterList
Get the number of IN parameters in this list.- Specified by:
getInParameterCount
in interfaceParameterList
- Returns:
- the number of IN parameters in this list
-
setIntParameter
Description copied from interface:ParameterList
Binds an integer value to a parameter. The type of the parameter is implicitly 'int4'.- Specified by:
setIntParameter
in interfaceParameterList
- Parameters:
index
- the 1-based parameter index to bind.value
- the integer value to use.- Throws:
SQLException
- on error or ifindex
is out of range
-
setLiteralParameter
Description copied from interface:ParameterList
Binds a String value that is an unquoted literal to the server's query parser (for example, a bare integer) to a parameter. Associated with the parameter is a typename for the parameter that should correspond to an entry in pg_types.- Specified by:
setLiteralParameter
in interfaceParameterList
- Parameters:
index
- the 1-based parameter index to bind.value
- the unquoted literal string to use.oid
- the type OID of the parameter, or0
to infer the type.- Throws:
SQLException
- on error or ifindex
is out of range
-
setStringParameter
Description copied from interface:ParameterList
Binds a String value that needs to be quoted for the server's parser to understand (for example, a timestamp) to a parameter. Associated with the parameter is a typename for the parameter that should correspond to an entry in pg_types.- Specified by:
setStringParameter
in interfaceParameterList
- Parameters:
index
- the 1-based parameter index to bind.value
- the quoted string to use.oid
- the type OID of the parameter, or0
to infer the type.- Throws:
SQLException
- on error or ifindex
is out of range
-
setBinaryParameter
Description copied from interface:ParameterList
Binds given byte[] value to a parameter. The bytes must already be in correct format matching the OID.- Specified by:
setBinaryParameter
in interfaceParameterList
- Parameters:
index
- the 1-based parameter index to bind.value
- the bytes to send.oid
- the type OID of the parameter.- Throws:
SQLException
- on error or ifindex
is out of range
-
setBytea
Description copied from interface:ParameterList
Binds a binary bytea value stored as a bytearray to a parameter. The parameter's type is implicitly set to 'bytea'. The bytearray's contains should remain unchanged until query execution has completed.- Specified by:
setBytea
in interfaceParameterList
- Parameters:
index
- the 1-based parameter index to bind.data
- an array containing the raw data valueoffset
- the offset withindata
of the start of the parameter data.length
- the number of bytes of parameter data withindata
to use.- Throws:
SQLException
- on error or ifindex
is out of range
-
setBytea
Description copied from interface:ParameterList
Binds a binary bytea value stored as an InputStream. The parameter's type is implicitly set to 'bytea'. The stream should remain valid until query execution has completed.- Specified by:
setBytea
in interfaceParameterList
- Parameters:
index
- the 1-based parameter index to bind.stream
- a stream containing the parameter data.length
- the number of bytes of parameter data to read fromstream
.- Throws:
SQLException
- on error or ifindex
is out of range
-
setBytea
Description copied from interface:ParameterList
Binds a binary bytea value stored as an InputStream. The parameter's type is implicitly set to 'bytea'. The stream should remain valid until query execution has completed.- Specified by:
setBytea
in interfaceParameterList
- Parameters:
index
- the 1-based parameter index to bind.stream
- a stream containing the parameter data.- Throws:
SQLException
- on error or ifindex
is out of range
-
setBytea
Description copied from interface:ParameterList
Binds a binary bytea value stored as a ByteStreamWriter. The parameter's type is implicitly set to 'bytea'. The stream should remain valid until query execution has completed.- Specified by:
setBytea
in interfaceParameterList
- Parameters:
index
- the 1-based parameter index to bind.writer
- a writer that can write the bytes for the parameter- Throws:
SQLException
- on error or ifindex
is out of range
-
setText
Description copied from interface:ParameterList
Binds a text value stored as an InputStream that is a valid UTF-8 byte stream. Any byte-order marks (BOM) in the stream are passed to the backend. The parameter's type is implicitly set to 'text'. The stream should remain valid until query execution has completed.- Specified by:
setText
in interfaceParameterList
- Parameters:
index
- the 1-based parameter index to bind.stream
- a stream containing the parameter data.- Throws:
SQLException
- on error or ifindex
is out of range
-
setNull
Description copied from interface:ParameterList
Binds a SQL NULL value to a parameter. Associated with the parameter is a typename for the parameter that should correspond to an entry in pg_types.- Specified by:
setNull
in interfaceParameterList
- Parameters:
index
- the 1-based parameter index to bind.oid
- the type OID of the parameter, or0
to infer the type.- Throws:
SQLException
- on error or ifindex
is out of range
-
toString
Description copied from interface:ParameterList
Return a human-readable representation of a particular parameter in this ParameterList. If the parameter is not bound, returns "?".- Specified by:
toString
in interfaceParameterList
- Parameters:
index
- the 1-based parameter index to bind.standardConformingStrings
- true if \ is not an escape character in strings literals- Returns:
- a string representation of the parameter.
-
checkAllParametersSet
Description copied from interface:V3ParameterList
Ensure that all parameters in this list have been assigned values. Return silently if all is well, otherwise throw an appropriate exception.- Specified by:
checkAllParametersSet
in interfaceV3ParameterList
- Throws:
SQLException
- if not all parameters are set.
-
convertFunctionOutParameters
public void convertFunctionOutParameters()Description copied from interface:V3ParameterList
Convert any function output parameters to the correct type (void) and set an ignorable value for it.- Specified by:
convertFunctionOutParameters
in interfaceV3ParameterList
-
streamBytea
- Throws:
IOException
-
streamBytea
- Throws:
IOException
-
getTypeOIDs
public int[] getTypeOIDs()Description copied from interface:ParameterList
Return the oids of the parameters in this list. May be null for a ParameterList that does not support typing of parameters.- Specified by:
getTypeOIDs
in interfaceParameterList
- Returns:
- oids of the parameters
-
getTypeOID
int getTypeOID(int index) -
hasUnresolvedTypes
boolean hasUnresolvedTypes() -
setResolvedType
void setResolvedType(int index, int oid) -
isNull
boolean isNull(int index) -
isBinary
boolean isBinary(int index) -
direction
private byte direction(int index) -
getV3Length
int getV3Length(int index) -
writeV3Value
- Throws:
IOException
-
copy
Description copied from interface:ParameterList
Perform a shallow copy of this ParameterList, returning a new instance (still suitable for passing to the owning Query). If this ParameterList is immutable, copy() may return the same immutable object.- Specified by:
copy
in interfaceParameterList
- Returns:
- a new ParameterList instance
-
clear
public void clear()Description copied from interface:ParameterList
Unbind all parameter values bound in this list.- Specified by:
clear
in interfaceParameterList
-
getSubparams
Description copied from interface:V3ParameterList
Return a list of the SimpleParameterList objects that make up this parameter list. If this object is already a SimpleParameterList, returns null (avoids an extra array construction in the common case).- Specified by:
getSubparams
in interfaceV3ParameterList
- Returns:
- an array of single-statement parameter lists, or
null
if this object is already a single-statement parameter list.
-
getValues
Description copied from interface:ParameterList
Returns the bound parameter values.- Specified by:
getValues
in interfaceParameterList
- Returns:
- Object array containing the parameter values.
-
getParamTypes
public int[] getParamTypes()Description copied from interface:V3ParameterList
Return the parameter type information.- Specified by:
getParamTypes
in interfaceV3ParameterList
- Returns:
- an array of
Oid
type information
-
getFlags
public byte[] getFlags()Description copied from interface:V3ParameterList
Return the flags for each parameter.- Specified by:
getFlags
in interfaceV3ParameterList
- Returns:
- an array of bytes used to store flags.
-
getEncoding
public byte[][] getEncoding()Description copied from interface:V3ParameterList
Return the encoding for each parameter.- Specified by:
getEncoding
in interfaceV3ParameterList
- Returns:
- nested byte array of bytes with encoding information.
-
appendAll
Description copied from interface:ParameterList
Use this operation to append more parameters to the current list.- Specified by:
appendAll
in interfaceParameterList
- Parameters:
list
- of parameters to append with.- Throws:
SQLException
- fault raised if driver or back end throw an exception
-
toString
Useful implementation of toString.
-