1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
|
/*-------------------------------------------------------------------------
*
* Copyright (c) 2003-2005, PostgreSQL Global Development Group
*
* IDENTIFICATION
* $PostgreSQL: pgjdbc/org/postgresql/core/BaseConnection.java,v 1.19 2006/12/01 08:53:45 jurka Exp $
*
*-------------------------------------------------------------------------
*/
package org.postgresql.core;
import java.sql.*;
import org.postgresql.PGConnection;
import org.postgresql.jdbc2.TimestampUtils;
/**
* Driver-internal connection interface. Application code should not use
* this interface.
*/
public interface BaseConnection extends PGConnection, Connection
{
/**
* Cancel the current query executing on this connection.
*
* @throws SQLException if something goes wrong.
*/
public void cancelQuery() throws SQLException;
/**
* Execute a SQL query that returns a single resultset.
* Never causes a new transaction to be started regardless of the autocommit setting.
*
* @param s the query to execute
* @return the (non-null) returned resultset
* @throws SQLException if something goes wrong.
*/
public ResultSet execSQLQuery(String s) throws SQLException;
public ResultSet execSQLQuery(String s, int resultSetType, int resultSetConcurrency) throws SQLException;
/**
* Execute a SQL query that does not return results.
* Never causes a new transaction to be started regardless of the autocommit setting.
*
* @param s the query to execute
* @throws SQLException if something goes wrong.
*/
public void execSQLUpdate(String s) throws SQLException;
/**
* Get the QueryExecutor implementation for this connection.
*
* @return the (non-null) executor
*/
public QueryExecutor getQueryExecutor();
/**
* Construct and return an appropriate object for the given
* type and value. This only considers the types registered via
* {@link org.postgresql.PGConnection#addDataType(String,Class)} and
* {@link org.postgresql.PGConnection#addDataType(String,String)}.
*<p>
* If no class is registered as handling the given type, then a generic
* {@link org.postgresql.util.PGobject} instance is returned.
*
* @param type the backend typename
* @param value the type-specific string representation of the value
* @return an appropriate object; never null.
* @throws SQLException if something goes wrong
*/
public Object getObject(String type, String value) throws SQLException;
public String getJavaClass(int oid) throws SQLException;
/**
* Look up the postgresql type name for a given oid. This is the
* inverse of {@link #getPGType(String)}.
*
* @param oid the type's OID
* @return the server type name for that OID, or null if unknown
* @throws SQLException if something goes wrong
*/
public String getPGType(int oid) throws SQLException;
/**
* Look up the oid for a given postgresql type name. This is the
* inverse of {@link #getPGType(int)}.
*
* @param pgTypeName the server type name to look up
* @return oid the type's OID, or 0 if unknown
* @throws SQLException if something goes wrong
*/
public int getPGType(String pgTypeName) throws SQLException;
/**
* Look up the SQL typecode for a given type oid.
*
* @param oid the type's OID
* @return the SQL typecode (a constant from {@link java.sql.Types}) for the type
* @throws SQLException if something goes wrong
*/
public int getSQLType(int oid) throws SQLException;
/**
* Look up the SQL typecode for a given postgresql type name.
*
* @param pgTypeName the server type name to look up
* @return the SQL typecode (a constant from {@link java.sql.Types}) for the type
* @throws SQLException if something goes wrong
*/
public int getSQLType(String pgTypeName) throws SQLException;
/**
* Check if we should use driver behaviour introduced in a particular
* driver version. This defaults to behaving as the actual driver's version
* but can be overridden by the "compatible" URL parameter.
*
* @param ver the driver version to check
* @return true if the driver's behavioural version is at least "ver".
* @throws SQLException if something goes wrong
*/
public boolean haveMinimumCompatibleVersion(String ver);
/**
* Check if we have at least a particular server version.
*
* @param ver the server version to check
* @return true if the server version is at least "ver".
* @throws SQLException if something goes wrong
*/
public boolean haveMinimumServerVersion(String ver);
/**
* Encode a string using the database's client_encoding
* (usually UNICODE, but can vary on older server versions).
* This is used when constructing synthetic resultsets (for
* example, in metadata methods).
*
* @param str the string to encode
* @return an encoded representation of the string
* @throws SQLException if something goes wrong.
*/
public byte[] encodeString(String str) throws SQLException;
/**
* Escapes a string for use as string-literal within an SQL command. The
* method chooses the applicable escaping rules based on the value of
* {@link #getStandardConformingStrings()}.
*
* @param str a string value
* @return the escaped representation of the string
* @throws SQLException if the string contains a <tt>\0</tt> character
*/
public String escapeString(String str) throws SQLException;
/**
* Returns whether the server treats string-literals according to the SQL
* standard or if it uses traditional PostgreSQL escaping rules. Versions
* up to 8.1 always treated backslashes as escape characters in
* string-literals. Since 8.2, this depends on the value of the
* <tt>standard_conforming_strings<tt> server variable.
*
* @return true if the server treats string literals according to the SQL
* standard
*
* @see ProtocolConnection#getStandardConformingStrings()
*/
public boolean getStandardConformingStrings();
// Ew. Quick hack to give access to the connection-specific utils implementation.
public TimestampUtils getTimestampUtils();
// Get the per-connection logger.
public Logger getLogger();
// Get the bind-string-as-varchar config flag
public boolean getStringVarcharFlag();
}
|