AbstractJdbc1Statement.java 57.9 KB
Newer Older
1
package org.postgresql.jdbc1;
2

3 4 5
import java.io.*;

import java.math.BigDecimal;
6
import java.sql.*;
7 8 9
import java.util.Vector;
import org.postgresql.largeobject.*;
import org.postgresql.util.*;
10

11
/* $Header: /cvsroot/pgsql/src/interfaces/jdbc/org/postgresql/jdbc1/Attic/AbstractJdbc1Statement.java,v 1.9 2002/09/11 05:38:44 barry Exp $
12 13 14
 * This class defines methods of the jdbc1 specification.  This class is
 * extended by org.postgresql.jdbc2.AbstractJdbc2Statement which adds the jdbc2
 * methods.  The real Statement class (for jdbc1) is org.postgresql.jdbc1.Jdbc1Statement
15
 */
16
public abstract class AbstractJdbc1Statement implements org.postgresql.PGStatement
17 18
{

19 20
	// The connection who created us
	protected AbstractJdbc1Connection connection;
21

22 23 24 25 26 27 28 29 30
	/** The warnings chain. */
	protected SQLWarning warnings = null;

	/** Maximum number of rows to return, 0 = unlimited */
	protected int maxrows = 0;

	/** Timeout (in seconds) for a query (not used) */
	protected int timeout = 0;

31
	protected boolean replaceProcessingEnabled = true;
32

33 34 35
	/** The current results */
	protected java.sql.ResultSet result = null;

36
	// Static variables for parsing SQL when replaceProcessing is true.
37 38 39 40 41
	private static final short IN_SQLCODE = 0;
	private static final short IN_STRING = 1;
	private static final short BACKSLASH = 2;
	private static final short ESC_TIMEDATE = 3;

42
	// Some performance caches
43
	private StringBuffer sbuf = new StringBuffer(32);
44

45
	//Used by the preparedstatement style methods
46
	protected String[] m_sqlFragments;
47 48
	private String[] m_origSqlFragments;
	private String[] m_executeSqlFragments;
49
	protected Object[] m_binds = new Object[0];
50 51 52 53
	private String[] m_bindTypes = new String[0];
	private String m_statementName = null;
	private boolean m_useServerPrepare = false;
	private static int m_preparedCount = 1;
54

55 56 57 58 59 60
	//Used by the callablestatement style methods
	private static final String JDBC_SYNTAX = "{[? =] call <some_function> ([? [,?]*]) }";
	private static final String RESULT_COLUMN = "result";
	private String originalSql = "";
	private boolean isFunction;
	// functionReturnType contains the user supplied value to check
61
	// testReturn contains a modified version to make it easier to
62 63 64 65 66 67 68
	// check the getXXX methods..
	private int functionReturnType;
	private int testReturn;
	// returnTypeSet is true when a proper call to registerOutParameter has been made
	private boolean returnTypeSet;
	protected Object callResult;

69 70 71 72 73 74 75


	public AbstractJdbc1Statement (AbstractJdbc1Connection connection)
	{
		this.connection = connection;
	}

76
	public AbstractJdbc1Statement (AbstractJdbc1Connection connection, String p_sql) throws SQLException
77 78
	{
		this.connection = connection;
79
		parseSqlStmt(p_sql);  // this allows Callable stmt to override
80 81
	}

82 83 84
	protected void parseSqlStmt (String p_sql) throws SQLException
	{
		String l_sql = p_sql;
85

86
		l_sql = replaceProcessing(l_sql);
87

88 89 90 91
		if (this instanceof CallableStatement)
		{
			l_sql = modifyJdbcCall(l_sql);
		}
92

93 94 95 96
		Vector v = new Vector();
		boolean inQuotes = false;
		int lastParmEnd = 0, i;

97
		for (i = 0; i < l_sql.length(); ++i)
98
		{
99
			int c = l_sql.charAt(i);
100 101 102 103 104

			if (c == '\'')
				inQuotes = !inQuotes;
			if (c == '?' && !inQuotes)
			{
105
				v.addElement(l_sql.substring (lastParmEnd, i));
106 107 108
				lastParmEnd = i + 1;
			}
		}
109
		v.addElement(l_sql.substring (lastParmEnd, l_sql.length()));
110

111 112
		m_sqlFragments = new String[v.size()];
		m_binds = new String[v.size() - 1];
113
		m_bindTypes = new String[v.size() - 1];
114

115 116
		for (i = 0 ; i < m_sqlFragments.length; ++i)
			m_sqlFragments[i] = (String)v.elementAt(i);
117

118 119 120
	}


121 122 123 124 125 126 127
	/*
	 * Execute a SQL statement that retruns a single ResultSet
	 *
	 * @param sql typically a static SQL SELECT statement
	 * @return a ResulSet that contains the data produced by the query
	 * @exception SQLException if a database access error occurs
	 */
128
	public java.sql.ResultSet executeQuery(String p_sql) throws SQLException
129
	{
130 131
		String l_sql = replaceProcessing(p_sql);
		m_sqlFragments = new String[] {l_sql};
132 133 134 135 136 137 138 139
		//If we have already created a server prepared statement, we need
		//to deallocate the existing one
		if (m_statementName != null) {
			((AbstractJdbc1Connection)connection).ExecSQL("DEALLOCATE " + m_statementName);
			m_statementName = null;
			m_origSqlFragments = null;
			m_executeSqlFragments = null;
		}
140
		return executeQuery();
141 142
	}

143 144 145 146 147 148 149 150 151
	/*
	 * A Prepared SQL query is executed and its ResultSet is returned
	 *
	 * @return a ResultSet that contains the data produced by the
	 *		 *	query - never null
	 * @exception SQLException if a database access error occurs
	 */
	public java.sql.ResultSet executeQuery() throws SQLException
	{
152 153 154 155 156 157
		this.execute();
		while (result != null && !((AbstractJdbc1ResultSet)result).reallyResultSet())
			result = ((AbstractJdbc1ResultSet)result).getNext();
		if (result == null)
			throw new PSQLException("postgresql.stat.noresult");
		return result;
158 159
	}

160 161 162 163 164 165 166 167 168
	/*
	 * Execute a SQL INSERT, UPDATE or DELETE statement.  In addition
	 * SQL statements that return nothing such as SQL DDL statements
	 * can be executed
	 *
	 * @param sql a SQL statement
	 * @return either a row count, or 0 for SQL commands
	 * @exception SQLException if a database access error occurs
	 */
169
	public int executeUpdate(String p_sql) throws SQLException
170
	{
171 172
		String l_sql = replaceProcessing(p_sql);
		m_sqlFragments = new String[] {l_sql};
173
		m_binds = new Object[0];
174 175 176 177 178 179 180 181
		//If we have already created a server prepared statement, we need
		//to deallocate the existing one
		if (m_statementName != null) {
			((AbstractJdbc1Connection)connection).ExecSQL("DEALLOCATE " + m_statementName);
			m_statementName = null;
			m_origSqlFragments = null;
			m_executeSqlFragments = null;
		}
182
		return executeUpdate();
183 184
	}

185 186 187 188 189 190 191 192 193 194 195
	/*
	 * Execute a SQL INSERT, UPDATE or DELETE statement.  In addition,
	 * SQL statements that return nothing such as SQL DDL statements can
	 * be executed.
	 *
	 * @return either the row count for INSERT, UPDATE or DELETE; or
	 *		 *	0 for SQL statements that return nothing.
	 * @exception SQLException if a database access error occurs
	 */
	public int executeUpdate() throws SQLException
	{
196 197 198 199
		this.execute();
		if (((AbstractJdbc1ResultSet)result).reallyResultSet())
			throw new PSQLException("postgresql.stat.result");
		return this.getUpdateCount();
200 201
	}

202 203 204 205 206 207 208 209 210 211 212
	/*
	 * Execute a SQL statement that may return multiple results. We
	 * don't have to worry about this since we do not support multiple
	 * ResultSets.	 You can use getResultSet or getUpdateCount to
	 * retrieve the result.
	 *
	 * @param sql any SQL statement
	 * @return true if the next result is a ResulSet, false if it is
	 *	an update count or there are no more results
	 * @exception SQLException if a database access error occurs
	 */
213 214
	public boolean execute(String p_sql) throws SQLException
	{
215 216
		String l_sql = replaceProcessing(p_sql);
		m_sqlFragments = new String[] {l_sql};
217
		m_binds = new Object[0];
218 219 220 221 222 223 224 225
		//If we have already created a server prepared statement, we need
		//to deallocate the existing one
		if (m_statementName != null) {
			((AbstractJdbc1Connection)connection).ExecSQL("DEALLOCATE " + m_statementName);
			m_statementName = null;
			m_origSqlFragments = null;
			m_executeSqlFragments = null;
		}
226
		return execute();
227 228 229 230 231 232 233 234 235 236 237 238
	}

	/*
	 * Some prepared statements return multiple results; the execute method
	 * handles these complex statements as well as the simpler form of
	 * statements handled by executeQuery and executeUpdate
	 *
	 * @return true if the next result is a ResultSet; false if it is an
	 *		 *	update count or there are no more results
	 * @exception SQLException if a database access error occurs
	 */
	public boolean execute() throws SQLException
239
	{
240 241
		if (isFunction && !returnTypeSet)
			throw new PSQLException("postgresql.call.noreturntype");
242 243
		if (isFunction)
		{ // set entry 1 to dummy entry..
244
			m_binds[0] = ""; // dummy entry which ensured that no one overrode
245
			m_bindTypes[0] = PG_TEXT;
246 247
			// and calls to setXXX (2,..) really went to first arg in a function call..
		}
248 249 250 251

		// New in 7.1, if we have a previous resultset then force it to close
		// This brings us nearer to compliance, and helps memory management.
		// Internal stuff will call ExecSQL directly, bypassing this.
252

253 254 255 256 257 258 259
		if (result != null)
		{
			java.sql.ResultSet rs = getResultSet();
			if (rs != null)
				rs.close();
		}

260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
		//Use server prepared statements if directed
		if (m_useServerPrepare)
		{
			if (m_statementName == null)
			{
				m_statementName = "JDBC_STATEMENT_" + m_preparedCount++;
				m_origSqlFragments = new String[m_sqlFragments.length];
				m_executeSqlFragments = new String[m_sqlFragments.length];
				System.arraycopy(m_sqlFragments, 0, m_origSqlFragments, 0, m_sqlFragments.length);
				m_executeSqlFragments[0] = "EXECUTE " + m_statementName;
				if (m_sqlFragments.length > 1)
				{
					m_executeSqlFragments[0] = m_executeSqlFragments[0] + "(";
					for (int i = 1; i < m_bindTypes.length; i++)
					{
						m_executeSqlFragments[i] = ", ";
					}
					m_executeSqlFragments[m_bindTypes.length] = ")";
				}
				synchronized (sbuf)
				{
					sbuf.setLength(0);
					sbuf.append("PREPARE ");
					sbuf.append(m_statementName);
					if (m_origSqlFragments.length > 1)
					{
						sbuf.append("(");
						for (int i = 0; i < m_bindTypes.length - 1; i++)
						{
							sbuf.append(m_bindTypes[i]);
							sbuf.append(", ");
						}
						sbuf.append(m_bindTypes[m_bindTypes.length - 1]);
						sbuf.append(")");
					}
					sbuf.append(" AS ");
					sbuf.append(m_origSqlFragments[0]);
					for (int i = 1; i < m_origSqlFragments.length; i++)
					{
						sbuf.append(" $");
						sbuf.append(i);
						sbuf.append(" ");
						sbuf.append(m_origSqlFragments[i]);
					}
					sbuf.append("; ");

					sbuf.append(m_executeSqlFragments[0]);
					m_sqlFragments[0] = sbuf.toString();
					System.arraycopy(m_executeSqlFragments, 1, m_sqlFragments, 1, m_sqlFragments.length - 1);
				}
310

311 312 313 314 315
			}
			else
			{
				m_sqlFragments = m_executeSqlFragments;
			}
316
		}
317 318

		// New in 7.1, pass Statement so that ExecSQL can customise to it
319
		result = ((AbstractJdbc1Connection)connection).ExecSQL(m_sqlFragments, m_binds, (java.sql.Statement)this);
320

321 322 323 324 325
		//If we are executing a callable statement function set the return data
		if (isFunction)
		{
			if (!((AbstractJdbc1ResultSet)result).reallyResultSet())
				throw new PSQLException("postgresql.call.noreturnval");
326 327 328 329
			if (!result.next ())
				throw new PSQLException ("postgresql.call.noreturnval");
			callResult = result.getObject(1);
			int columnType = result.getMetaData().getColumnType(1);
330
			if (columnType != functionReturnType)
331 332
				throw new PSQLException ("postgresql.call.wrongrtntype",
										 new Object[]{
333 334 335 336 337 338 339
											 "java.sql.Types=" + columnType, "java.sql.Types=" + functionReturnType });
			result.close ();
			return true;
		}
		else
		{
			return (result != null && ((AbstractJdbc1ResultSet)result).reallyResultSet());
340
		}
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
	}

	/*
	 * setCursorName defines the SQL cursor name that will be used by
	 * subsequent execute methods.	This name can then be used in SQL
	 * positioned update/delete statements to identify the current row
	 * in the ResultSet generated by this statement.  If a database
	 * doesn't support positioned update/delete, this method is a
	 * no-op.
	 *
	 * <p><B>Note:</B> By definition, positioned update/delete execution
	 * must be done by a different Statement than the one which
	 * generated the ResultSet being used for positioning.	Also, cursor
	 * names must be unique within a Connection.
	 *
	 * <p>We throw an additional constriction.	There can only be one
	 * cursor active at any one time.
	 *
	 * @param name the new cursor name
	 * @exception SQLException if a database access error occurs
	 */
	public void setCursorName(String name) throws SQLException
	{
		((AbstractJdbc1Connection)connection).setCursorName(name);
	}


	/*
	 * getUpdateCount returns the current result as an update count,
	 * if the result is a ResultSet or there are no more results, -1
	 * is returned.  It should only be called once per result.
	 *
	 * @return the current result as an update count.
	 * @exception SQLException if a database access error occurs
	 */
	public int getUpdateCount() throws SQLException
	{
		if (result == null)
			return -1;
380 381
		if (isFunction)
			return 1;
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
		if (((AbstractJdbc1ResultSet)result).reallyResultSet())
			return -1;
		return ((AbstractJdbc1ResultSet)result).getResultCount();
	}

	/*
	 * getMoreResults moves to a Statement's next result.  If it returns
	 * true, this result is a ResulSet.
	 *
	 * @return true if the next ResultSet is valid
	 * @exception SQLException if a database access error occurs
	 */
	public boolean getMoreResults() throws SQLException
	{
		result = ((AbstractJdbc1ResultSet)result).getNext();
		return (result != null && ((AbstractJdbc1ResultSet)result).reallyResultSet());
	}



402
	/*
403 404 405 406 407 408 409 410 411
	 * Returns the status message from the current Result.<p>
	 * This is used internally by the driver.
	 *
	 * @return status message from backend
	 */
	public String getResultStatusString()
	{
		if (result == null)
			return null;
412
		return ((AbstractJdbc1ResultSet)result).getStatusString();
413 414
	}

415
	/*
416 417 418 419 420 421 422 423 424 425 426 427
	 * The maxRows limit is set to limit the number of rows that
	 * any ResultSet can contain.  If the limit is exceeded, the
	 * excess rows are silently dropped.
	 *
	 * @return the current maximum row limit; zero means unlimited
	 * @exception SQLException if a database access error occurs
	 */
	public int getMaxRows() throws SQLException
	{
		return maxrows;
	}

428
	/*
429 430 431 432 433 434 435 436 437 438 439
	 * Set the maximum number of rows
	 *
	 * @param max the new max rows limit; zero means unlimited
	 * @exception SQLException if a database access error occurs
	 * @see getMaxRows
	 */
	public void setMaxRows(int max) throws SQLException
	{
		maxrows = max;
	}

440
	/*
441 442 443 444 445 446 447 448
	 * If escape scanning is on (the default), the driver will do escape
	 * substitution before sending the SQL to the database.
	 *
	 * @param enable true to enable; false to disable
	 * @exception SQLException if a database access error occurs
	 */
	public void setEscapeProcessing(boolean enable) throws SQLException
	{
449
		replaceProcessingEnabled = enable;
450 451
	}

452
	/*
453 454 455 456 457 458 459 460 461 462 463 464
	 * The queryTimeout limit is the number of seconds the driver
	 * will wait for a Statement to execute.  If the limit is
	 * exceeded, a SQLException is thrown.
	 *
	 * @return the current query timeout limit in seconds; 0 = unlimited
	 * @exception SQLException if a database access error occurs
	 */
	public int getQueryTimeout() throws SQLException
	{
		return timeout;
	}

465
	/*
466 467 468 469 470 471 472 473 474 475
	 * Sets the queryTimeout limit
	 *
	 * @param seconds - the new query timeout limit in seconds
	 * @exception SQLException if a database access error occurs
	 */
	public void setQueryTimeout(int seconds) throws SQLException
	{
		timeout = seconds;
	}

476 477 478 479 480
	/**
	 * This adds a warning to the warning chain.
	 * @param msg message to add
	 */
	public void addWarning(String msg)
481 482 483 484 485
	{
		if (warnings != null)
			warnings.setNextWarning(new SQLWarning(msg));
		else
			warnings = new SQLWarning(msg);
486 487
	}

488
	/*
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
	 * The first warning reported by calls on this Statement is
	 * returned.  A Statement's execute methods clear its SQLWarning
	 * chain.  Subsequent Statement warnings will be chained to this
	 * SQLWarning.
	 *
	 * <p>The Warning chain is automatically cleared each time a statement
	 * is (re)executed.
	 *
	 * <p><B>Note:</B>	If you are processing a ResultSet then any warnings
	 * associated with ResultSet reads will be chained on the ResultSet
	 * object.
	 *
	 * @return the first SQLWarning on null
	 * @exception SQLException if a database access error occurs
	 */
	public SQLWarning getWarnings() throws SQLException
	{
		return warnings;
	}

509
	/*
510 511 512 513 514 515 516 517 518 519 520 521 522 523
	 * The maxFieldSize limit (in bytes) is the maximum amount of
	 * data returned for any column value; it only applies to
	 * BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR and LONGVARCHAR
	 * columns.  If the limit is exceeded, the excess data is silently
	 * discarded.
	 *
	 * @return the current max column size limit; zero means unlimited
	 * @exception SQLException if a database access error occurs
	 */
	public int getMaxFieldSize() throws SQLException
	{
		return 8192;		// We cannot change this
	}

524
	/*
525 526 527 528 529 530 531 532 533 534 535
	 * Sets the maxFieldSize - NOT! - We throw an SQLException just
	 * to inform them to stop doing this.
	 *
	 * @param max the new max column size limit; zero means unlimited
	 * @exception SQLException if a database access error occurs
	 */
	public void setMaxFieldSize(int max) throws SQLException
	{
		throw new PSQLException("postgresql.stat.maxfieldsize");
	}

536
	/*
537 538 539 540 541 542 543 544 545 546
	 * After this call, getWarnings returns null until a new warning
	 * is reported for this Statement.
	 *
	 * @exception SQLException if a database access error occurs
	 */
	public void clearWarnings() throws SQLException
	{
		warnings = null;
	}

547
	/*
548 549 550 551 552 553 554 555 556
	 * Cancel can be used by one thread to cancel a statement that
	 * is being executed by another thread.
	 * <p>
	 * Not implemented, this method is a no-op.
	 *
	 * @exception SQLException only because thats the spec.
	 */
	public void cancel() throws SQLException
	{
557
		throw new PSQLException("postgresql.unimplemented");
558 559
	}

560
	/*
561 562 563 564 565 566 567 568
	 * getResultSet returns the current result as a ResultSet.	It
	 * should only be called once per result.
	 *
	 * @return the current result set; null if there are no more
	 * @exception SQLException if a database access error occurs (why?)
	 */
	public java.sql.ResultSet getResultSet() throws SQLException
	{
569
		if (result != null && ((AbstractJdbc1ResultSet) result).reallyResultSet())
570 571 572 573
			return result;
		return null;
	}

574
	/*
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
	 * In many cases, it is desirable to immediately release a
	 * Statement's database and JDBC resources instead of waiting
	 * for this to happen when it is automatically closed.	The
	 * close method provides this immediate release.
	 *
	 * <p><B>Note:</B> A Statement is automatically closed when it is
	 * garbage collected.  When a Statement is closed, its current
	 * ResultSet, if one exists, is also closed.
	 *
	 * @exception SQLException if a database access error occurs (why?)
	 */
	public void close() throws SQLException
	{
		// Force the ResultSet to close
		java.sql.ResultSet rs = getResultSet();
		if (rs != null)
			rs.close();

593 594 595 596 597
		// If using server prepared statements deallocate them
		if (m_useServerPrepare && m_statementName != null) {
			((AbstractJdbc1Connection)connection).ExecSQL("DEALLOCATE " + m_statementName);
		}

598 599 600 601
		// Disasociate it from us (For Garbage Collection)
		result = null;
	}

602
	/*
603 604 605 606 607 608 609 610 611
	 * Filter the SQL string of Java SQL Escape clauses.
	 *
	 * Currently implemented Escape clauses are those mentioned in 11.3
	 * in the specification. Basically we look through the sql string for
	 * {d xxx}, {t xxx} or {ts xxx} in non-string sql code. When we find
	 * them, we just strip the escape part leaving only the xxx part.
	 * So, something like "select * from x where d={d '2001-10-09'}" would
	 * return "select * from x where d= '2001-10-09'".
	 */
612
	protected String replaceProcessing(String p_sql)
613
	{
614
		if (replaceProcessingEnabled)
615
		{
616 617 618 619 620 621 622 623
			// Since escape codes can only appear in SQL CODE, we keep track
			// of if we enter a string or not.
			StringBuffer newsql = new StringBuffer(p_sql.length());
			short state = IN_SQLCODE;

			int i = -1;
			int len = p_sql.length();
			while (++i < len)
624
			{
625 626 627 628 629 630 631 632
				char c = p_sql.charAt(i);
				switch (state)
				{
					case IN_SQLCODE:
						if (c == '\'')				  // start of a string?
							state = IN_STRING;
						else if (c == '{')			  // start of an escape code?
							if (i + 1 < len)
633
							{
634 635 636 637 638 639 640 641 642 643 644 645 646
								char next = p_sql.charAt(i + 1);
								if (next == 'd')
								{
									state = ESC_TIMEDATE;
									i++;
									break;
								}
								else if (next == 't')
								{
									state = ESC_TIMEDATE;
									i += (i + 2 < len && p_sql.charAt(i + 2) == 's') ? 2 : 1;
									break;
								}
647
							}
648 649
						newsql.append(c);
						break;
650

651 652 653 654 655
					case IN_STRING:
						if (c == '\'')				   // end of string?
							state = IN_SQLCODE;
						else if (c == '\\')			   // a backslash?
							state = BACKSLASH;
656

657 658
						newsql.append(c);
						break;
659

660 661
					case BACKSLASH:
						state = IN_STRING;
662 663

						newsql.append(c);
664 665 666 667 668 669 670 671 672 673
						break;

					case ESC_TIMEDATE:
						if (c == '}')
							state = IN_SQLCODE;		  // end of escape code.
						else
							newsql.append(c);
						break;
				} // end switch
			}
674

675 676 677 678 679 680
			return newsql.toString();
		}
		else
		{
			return p_sql;
		}
681
	}
682

683 684 685 686 687 688
	/*
	 *
	 * The following methods are postgres extensions and are defined
	 * in the interface org.postgresql.Statement
	 *
	 */
689 690 691

	/*
	 * Returns the Last inserted/updated oid.  Deprecated in 7.2 because
692
			* range of OID values is greater than a java signed int.
693 694 695 696 697 698 699 700 701 702
	 * @deprecated Replaced by getLastOID in 7.2
	 */
	public int getInsertedOID() throws SQLException
	{
		if (result == null)
			return 0;
		return (int)((AbstractJdbc1ResultSet)result).getLastOID();
	}

	/*
703
	 * Returns the Last inserted/updated oid.
704
	 * @return OID of last insert
705
			* @since 7.2
706 707 708 709 710 711 712 713
	 */
	public long getLastOID() throws SQLException
	{
		if (result == null)
			return 0;
		return ((AbstractJdbc1ResultSet)result).getLastOID();
	}

714 715 716 717 718 719 720 721 722 723 724 725
	/*
	 * Set a parameter to SQL NULL
	 *
	 * <p><B>Note:</B> You must specify the parameters SQL type (although
	 * PostgreSQL ignores it)
	 *
	 * @param parameterIndex the first parameter is 1, etc...
	 * @param sqlType the SQL type code defined in java.sql.Types
	 * @exception SQLException if a database access error occurs
	 */
	public void setNull(int parameterIndex, int sqlType) throws SQLException
	{
726
		bind(parameterIndex, "null", PG_TEXT);
727 728 729 730 731 732 733 734 735 736 737 738
	}

	/*
	 * Set a parameter to a Java boolean value.  The driver converts this
	 * to a SQL BIT value when it sends it to the database.
	 *
	 * @param parameterIndex the first parameter is 1...
	 * @param x the parameter value
	 * @exception SQLException if a database access error occurs
	 */
	public void setBoolean(int parameterIndex, boolean x) throws SQLException
	{
739
		bind(parameterIndex, x ? "'t'" : "'f'", PG_BOOLEAN);
740 741 742 743 744 745 746 747 748 749 750 751
	}

	/*
	 * Set a parameter to a Java byte value.  The driver converts this to
	 * a SQL TINYINT value when it sends it to the database.
	 *
	 * @param parameterIndex the first parameter is 1...
	 * @param x the parameter value
	 * @exception SQLException if a database access error occurs
	 */
	public void setByte(int parameterIndex, byte x) throws SQLException
	{
752
		bind(parameterIndex, Integer.toString(x), PG_TEXT);
753 754 755 756 757 758 759 760 761 762 763 764
	}

	/*
	 * Set a parameter to a Java short value.  The driver converts this
	 * to a SQL SMALLINT value when it sends it to the database.
	 *
	 * @param parameterIndex the first parameter is 1...
	 * @param x the parameter value
	 * @exception SQLException if a database access error occurs
	 */
	public void setShort(int parameterIndex, short x) throws SQLException
	{
765 766 767 768
		//Note this should be fixed
		//as soon as the backend correctly supports int8 type
		//comparisons
		bind(parameterIndex, "'" + Integer.toString(x) + "'", PG_INT2);
769 770 771 772 773 774 775 776 777 778 779 780
	}

	/*
	 * Set a parameter to a Java int value.  The driver converts this to
	 * a SQL INTEGER value when it sends it to the database.
	 *
	 * @param parameterIndex the first parameter is 1...
	 * @param x the parameter value
	 * @exception SQLException if a database access error occurs
	 */
	public void setInt(int parameterIndex, int x) throws SQLException
	{
781
		bind(parameterIndex, Integer.toString(x), PG_INTEGER);
782 783 784 785 786 787 788 789 790 791 792 793
	}

	/*
	 * Set a parameter to a Java long value.  The driver converts this to
	 * a SQL BIGINT value when it sends it to the database.
	 *
	 * @param parameterIndex the first parameter is 1...
	 * @param x the parameter value
	 * @exception SQLException if a database access error occurs
	 */
	public void setLong(int parameterIndex, long x) throws SQLException
	{
794 795 796 797
		//Note this should be fixed
		//as soon as the backend correctly supports int8 type
		//comparisons
		bind(parameterIndex, "'" + Long.toString(x) + "'", PG_INT8);
798 799 800 801 802 803 804 805 806 807 808 809
	}

	/*
	 * Set a parameter to a Java float value.  The driver converts this
	 * to a SQL FLOAT value when it sends it to the database.
	 *
	 * @param parameterIndex the first parameter is 1...
	 * @param x the parameter value
	 * @exception SQLException if a database access error occurs
	 */
	public void setFloat(int parameterIndex, float x) throws SQLException
	{
810 811 812 813
		//Note this should be fixed
		//as soon as the backend correctly supports int8 type
		//comparisons
		bind(parameterIndex, "'" + Float.toString(x) + "'", PG_FLOAT);
814 815 816 817 818 819 820 821 822 823 824 825
	}

	/*
	 * Set a parameter to a Java double value.	The driver converts this
	 * to a SQL DOUBLE value when it sends it to the database
	 *
	 * @param parameterIndex the first parameter is 1...
	 * @param x the parameter value
	 * @exception SQLException if a database access error occurs
	 */
	public void setDouble(int parameterIndex, double x) throws SQLException
	{
826 827 828 829
		//Note this should be fixed
		//as soon as the backend correctly supports int8 type
		//comparisons
		bind(parameterIndex, "'" + Double.toString(x) + "'", PG_DOUBLE);
830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
	}

	/*
	 * Set a parameter to a java.lang.BigDecimal value.  The driver
	 * converts this to a SQL NUMERIC value when it sends it to the
	 * database.
	 *
	 * @param parameterIndex the first parameter is 1...
	 * @param x the parameter value
	 * @exception SQLException if a database access error occurs
	 */
	public void setBigDecimal(int parameterIndex, BigDecimal x) throws SQLException
	{
		if (x == null)
			setNull(parameterIndex, Types.OTHER);
		else
		{
847 848 849 850
			//Note this should be fixed
			//as soon as the backend correctly supports int8 type
			//comparisons
			bind(parameterIndex, "'" + x.toString() + "'", PG_NUMERIC);
851 852 853 854 855 856 857 858 859 860 861 862 863 864
		}
	}

	/*
	 * Set a parameter to a Java String value.	The driver converts this
	 * to a SQL VARCHAR or LONGVARCHAR value (depending on the arguments
	 * size relative to the driver's limits on VARCHARs) when it sends it
	 * to the database.
	 *
	 * @param parameterIndex the first parameter is 1...
	 * @param x the parameter value
	 * @exception SQLException if a database access error occurs
	 */
	public void setString(int parameterIndex, String x) throws SQLException
865
	{
866
		setString(parameterIndex, x, PG_TEXT);
867 868 869
	}

	public void setString(int parameterIndex, String x, String type) throws SQLException
870 871 872 873 874 875 876 877 878 879 880
	{
		// if the passed string is null, then set this column to null
		if (x == null)
			setNull(parameterIndex, Types.OTHER);
		else
		{
			// use the shared buffer object. Should never clash but this makes
			// us thread safe!
			synchronized (sbuf)
			{
				sbuf.setLength(0);
881
				sbuf.ensureCapacity(x.length());
882 883 884 885 886 887 888 889 890 891 892
				int i;

				sbuf.append('\'');
				for (i = 0 ; i < x.length() ; ++i)
				{
					char c = x.charAt(i);
					if (c == '\\' || c == '\'')
						sbuf.append((char)'\\');
					sbuf.append(c);
				}
				sbuf.append('\'');
893
				bind(parameterIndex, sbuf.toString(), type);
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
			}
		}
	}

	/*
	 * Set a parameter to a Java array of bytes.  The driver converts this
	 * to a SQL VARBINARY or LONGVARBINARY (depending on the argument's
	 * size relative to the driver's limits on VARBINARYs) when it sends
	 * it to the database.
	 *
	 * <p>Implementation note:
	 * <br>With org.postgresql, this creates a large object, and stores the
	 * objects oid in this column.
	 *
	 * @param parameterIndex the first parameter is 1...
	 * @param x the parameter value
	 * @exception SQLException if a database access error occurs
	 */
	public void setBytes(int parameterIndex, byte x[]) throws SQLException
	{
		if (connection.haveMinimumCompatibleVersion("7.2"))
		{
			//Version 7.2 supports the bytea datatype for byte arrays
			if (null == x)
			{
				setNull(parameterIndex, Types.OTHER);
			}
			else
			{
923
				setString(parameterIndex, PGbytea.toPGString(x), PG_TEXT);
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
			}
		}
		else
		{
			//Version 7.1 and earlier support done as LargeObjects
			LargeObjectManager lom = connection.getLargeObjectAPI();
			int oid = lom.create();
			LargeObject lob = lom.open(oid);
			lob.write(x);
			lob.close();
			setInt(parameterIndex, oid);
		}
	}

	/*
	 * Set a parameter to a java.sql.Date value.  The driver converts this
	 * to a SQL DATE value when it sends it to the database.
	 *
	 * @param parameterIndex the first parameter is 1...
	 * @param x the parameter value
	 * @exception SQLException if a database access error occurs
	 */
	public void setDate(int parameterIndex, java.sql.Date x) throws SQLException
	{
		if (null == x)
		{
			setNull(parameterIndex, Types.OTHER);
		}
		else
		{
954
			bind(parameterIndex, "'" + x.toString() + "'", PG_DATE);
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973
		}
	}

	/*
	 * Set a parameter to a java.sql.Time value.  The driver converts
	 * this to a SQL TIME value when it sends it to the database.
	 *
	 * @param parameterIndex the first parameter is 1...));
	 * @param x the parameter value
	 * @exception SQLException if a database access error occurs
	 */
	public void setTime(int parameterIndex, Time x) throws SQLException
	{
		if (null == x)
		{
			setNull(parameterIndex, Types.OTHER);
		}
		else
		{
974
			bind(parameterIndex, "'" + x.toString() + "'", PG_TIME);
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
		}
	}

	/*
	 * Set a parameter to a java.sql.Timestamp value.  The driver converts
	 * this to a SQL TIMESTAMP value when it sends it to the database.
	 *
	 * @param parameterIndex the first parameter is 1...
	 * @param x the parameter value
	 * @exception SQLException if a database access error occurs
	 */
	public void setTimestamp(int parameterIndex, Timestamp x) throws SQLException
	{
		if (null == x)
		{
			setNull(parameterIndex, Types.OTHER);
		}
		else
993
		{
994 995 996 997
			// Use the shared StringBuffer
			synchronized (sbuf)
			{
				sbuf.setLength(0);
998
				sbuf.ensureCapacity(32);
999
				sbuf.append("'");
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
				//format the timestamp
				//we do our own formating so that we can get a format
				//that works with both timestamp with time zone and
				//timestamp without time zone datatypes.
				//The format is '2002-01-01 23:59:59.123456-0130'
				//we need to include the local time and timezone offset
				//so that timestamp without time zone works correctly
				int l_year = x.getYear() + 1900;
				sbuf.append(l_year);
				sbuf.append('-');
				int l_month = x.getMonth() + 1;
				if (l_month < 10)
					sbuf.append('0');
				sbuf.append(l_month);
				sbuf.append('-');
				int l_day = x.getDate();
				if (l_day < 10)
					sbuf.append('0');
				sbuf.append(l_day);
				sbuf.append(' ');
				int l_hours = x.getHours();
				if (l_hours < 10)
					sbuf.append('0');
				sbuf.append(l_hours);
				sbuf.append(':');
				int l_minutes = x.getMinutes();
				if (l_minutes < 10)
					sbuf.append('0');
				sbuf.append(l_minutes);
				sbuf.append(':');
				int l_seconds = x.getSeconds();
				if (l_seconds < 10)
					sbuf.append('0');
				sbuf.append(l_seconds);
				// Make decimal from nanos.
				char[] l_decimal = {'0', '0', '0', '0', '0', '0', '0', '0', '0'};
				char[] l_nanos = Integer.toString(x.getNanos()).toCharArray();
				System.arraycopy(l_nanos, 0, l_decimal, l_decimal.length - l_nanos.length, l_nanos.length);
				sbuf.append('.');
				if (connection.haveMinimumServerVersion("7.2"))
				{
					sbuf.append(l_decimal, 0, 6);
				}
				else
				{
					// Because 7.1 include bug that "hh:mm:59.999" becomes "hh:mm:60.00".
					sbuf.append(l_decimal, 0, 2);
				}
				//add timezone offset
				int l_offset = -(x.getTimezoneOffset());
				int l_houros = l_offset / 60;
				if (l_houros >= 0)
				{
					sbuf.append('+');
				}
				else
				{
					sbuf.append('-');
				}
				if (l_houros > -10 && l_houros < 10)
					sbuf.append('0');
				if (l_houros >= 0)
				{
					sbuf.append(l_houros);
				}
				else
				{
					sbuf.append( -l_houros);
				}
				int l_minos = l_offset - (l_houros * 60);
				if (l_minos != 0)
				{
					if (l_minos < 10)
						sbuf.append('0');
					sbuf.append(l_minos);
				}
1076
				sbuf.append("'");
1077
				bind(parameterIndex, sbuf.toString(), PG_TIMESTAMPTZ);
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
			}

		}
	}

	/*
	 * When a very large ASCII value is input to a LONGVARCHAR parameter,
	 * it may be more practical to send it via a java.io.InputStream.
	 * JDBC will read the data from the stream as needed, until it reaches
	 * end-of-file.  The JDBC driver will do any necessary conversion from
	 * ASCII to the database char format.
	 *
	 * <P><B>Note:</B> This stream object can either be a standard Java
	 * stream object or your own subclass that implements the standard
	 * interface.
	 *
	 * @param parameterIndex the first parameter is 1...
	 * @param x the parameter value
	 * @param length the number of bytes in the stream
	 * @exception SQLException if a database access error occurs
	 */
	public void setAsciiStream(int parameterIndex, InputStream x, int length) throws SQLException
	{
		if (connection.haveMinimumCompatibleVersion("7.2"))
		{
			//Version 7.2 supports AsciiStream for all PG text types (char, varchar, text)
			//As the spec/javadoc for this method indicate this is to be used for
			//large String values (i.e. LONGVARCHAR)  PG doesn't have a separate
			//long varchar datatype, but with toast all text datatypes are capable of
			//handling very large values.  Thus the implementation ends up calling
			//setString() since there is no current way to stream the value to the server
			try
			{
				InputStreamReader l_inStream = new InputStreamReader(x, "ASCII");
				char[] l_chars = new char[length];
				int l_charsRead = l_inStream.read(l_chars, 0, length);
1114
				setString(parameterIndex, new String(l_chars, 0, l_charsRead), PG_TEXT);
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
			}
			catch (UnsupportedEncodingException l_uee)
			{
				throw new PSQLException("postgresql.unusual", l_uee);
			}
			catch (IOException l_ioe)
			{
				throw new PSQLException("postgresql.unusual", l_ioe);
			}
		}
		else
		{
			//Version 7.1 supported only LargeObjects by treating everything
			//as binary data
			setBinaryStream(parameterIndex, x, length);
		}
	}

	/*
	 * When a very large Unicode value is input to a LONGVARCHAR parameter,
	 * it may be more practical to send it via a java.io.InputStream.
	 * JDBC will read the data from the stream as needed, until it reaches
	 * end-of-file.  The JDBC driver will do any necessary conversion from
	 * UNICODE to the database char format.
	 *
	 * <P><B>Note:</B> This stream object can either be a standard Java
	 * stream object or your own subclass that implements the standard
	 * interface.
	 *
	 * @param parameterIndex the first parameter is 1...
	 * @param x the parameter value
	 * @exception SQLException if a database access error occurs
	 */
	public void setUnicodeStream(int parameterIndex, InputStream x, int length) throws SQLException
	{
		if (connection.haveMinimumCompatibleVersion("7.2"))
		{
			//Version 7.2 supports AsciiStream for all PG text types (char, varchar, text)
			//As the spec/javadoc for this method indicate this is to be used for
			//large String values (i.e. LONGVARCHAR)  PG doesn't have a separate
			//long varchar datatype, but with toast all text datatypes are capable of
			//handling very large values.  Thus the implementation ends up calling
			//setString() since there is no current way to stream the value to the server
			try
			{
				InputStreamReader l_inStream = new InputStreamReader(x, "UTF-8");
				char[] l_chars = new char[length];
				int l_charsRead = l_inStream.read(l_chars, 0, length);
1163
				setString(parameterIndex, new String(l_chars, 0, l_charsRead), PG_TEXT);
1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274
			}
			catch (UnsupportedEncodingException l_uee)
			{
				throw new PSQLException("postgresql.unusual", l_uee);
			}
			catch (IOException l_ioe)
			{
				throw new PSQLException("postgresql.unusual", l_ioe);
			}
		}
		else
		{
			//Version 7.1 supported only LargeObjects by treating everything
			//as binary data
			setBinaryStream(parameterIndex, x, length);
		}
	}

	/*
	 * When a very large binary value is input to a LONGVARBINARY parameter,
	 * it may be more practical to send it via a java.io.InputStream.
	 * JDBC will read the data from the stream as needed, until it reaches
	 * end-of-file.
	 *
	 * <P><B>Note:</B> This stream object can either be a standard Java
	 * stream object or your own subclass that implements the standard
	 * interface.
	 *
	 * @param parameterIndex the first parameter is 1...
	 * @param x the parameter value
	 * @exception SQLException if a database access error occurs
	 */
	public void setBinaryStream(int parameterIndex, InputStream x, int length) throws SQLException
	{
		if (connection.haveMinimumCompatibleVersion("7.2"))
		{
			//Version 7.2 supports BinaryStream for for the PG bytea type
			//As the spec/javadoc for this method indicate this is to be used for
			//large binary values (i.e. LONGVARBINARY)	PG doesn't have a separate
			//long binary datatype, but with toast the bytea datatype is capable of
			//handling very large values.  Thus the implementation ends up calling
			//setBytes() since there is no current way to stream the value to the server
			byte[] l_bytes = new byte[length];
			int l_bytesRead;
			try
			{
				l_bytesRead = x.read(l_bytes, 0, length);
			}
			catch (IOException l_ioe)
			{
				throw new PSQLException("postgresql.unusual", l_ioe);
			}
			if (l_bytesRead == length)
			{
				setBytes(parameterIndex, l_bytes);
			}
			else
			{
				//the stream contained less data than they said
				byte[] l_bytes2 = new byte[l_bytesRead];
				System.arraycopy(l_bytes, 0, l_bytes2, 0, l_bytesRead);
				setBytes(parameterIndex, l_bytes2);
			}
		}
		else
		{
			//Version 7.1 only supported streams for LargeObjects
			//but the jdbc spec indicates that streams should be
			//available for LONGVARBINARY instead
			LargeObjectManager lom = connection.getLargeObjectAPI();
			int oid = lom.create();
			LargeObject lob = lom.open(oid);
			OutputStream los = lob.getOutputStream();
			try
			{
				// could be buffered, but then the OutputStream returned by LargeObject
				// is buffered internally anyhow, so there would be no performance
				// boost gained, if anything it would be worse!
				int c = x.read();
				int p = 0;
				while (c > -1 && p < length)
				{
					los.write(c);
					c = x.read();
					p++;
				}
				los.close();
			}
			catch (IOException se)
			{
				throw new PSQLException("postgresql.unusual", se);
			}
			// lob is closed by the stream so don't call lob.close()
			setInt(parameterIndex, oid);
		}
	}


	/*
	 * In general, parameter values remain in force for repeated used of a
	 * Statement.  Setting a parameter value automatically clears its
	 * previous value.	However, in coms cases, it is useful to immediately
	 * release the resources used by the current parameter values; this
	 * can be done by calling clearParameters
	 *
	 * @exception SQLException if a database access error occurs
	 */
	public void clearParameters() throws SQLException
	{
		int i;

1275 1276
		for (i = 0 ; i < m_binds.length ; i++)
		{
1277
			m_binds[i] = null;
1278
			m_bindTypes[i] = null;
1279
		}
1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305
	}

	/*
	 * Set the value of a parameter using an object; use the java.lang
	 * equivalent objects for integral values.
	 *
	 * <P>The given Java object will be converted to the targetSqlType before
	 * being sent to the database.
	 *
	 * <P>note that this method may be used to pass database-specific
	 * abstract data types.  This is done by using a Driver-specific
	 * Java type and using a targetSqlType of java.sql.Types.OTHER
	 *
	 * @param parameterIndex the first parameter is 1...
	 * @param x the object containing the input parameter value
	 * @param targetSqlType The SQL type to be send to the database
	 * @param scale For java.sql.Types.DECIMAL or java.sql.Types.NUMERIC
	 *		 *	types this is the number of digits after the decimal.  For
	 *		 *	all other types this value will be ignored.
	 * @exception SQLException if a database access error occurs
	 */
	public void setObject(int parameterIndex, Object x, int targetSqlType, int scale) throws SQLException
	{
		if (x == null)
		{
			setNull(parameterIndex, Types.OTHER);
1306
			return ;
1307 1308 1309
		}
		switch (targetSqlType)
		{
1310
			case Types.INTEGER:
1311
				bind(parameterIndex, x.toString(), PG_INTEGER);
1312
				break;
1313 1314 1315 1316 1317 1318 1319 1320 1321
			case Types.TINYINT:
			case Types.SMALLINT:
			case Types.BIGINT:
			case Types.REAL:
			case Types.FLOAT:
			case Types.DOUBLE:
			case Types.DECIMAL:
			case Types.NUMERIC:
				if (x instanceof Boolean)
1322
					bind(parameterIndex, ((Boolean)x).booleanValue() ? "1" : "0", PG_BOOLEAN);
1323
				else
1324 1325 1326 1327
					//Note this should be fixed
					//as soon as the backend correctly supports int8 type
					//comparisons
					bind(parameterIndex, "'" + x.toString() + "'", PG_NUMERIC);
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345
				break;
			case Types.CHAR:
			case Types.VARCHAR:
			case Types.LONGVARCHAR:
				setString(parameterIndex, x.toString());
				break;
			case Types.DATE:
				setDate(parameterIndex, (java.sql.Date)x);
				break;
			case Types.TIME:
				setTime(parameterIndex, (Time)x);
				break;
			case Types.TIMESTAMP:
				setTimestamp(parameterIndex, (Timestamp)x);
				break;
			case Types.BIT:
				if (x instanceof Boolean)
				{
1346
					bind(parameterIndex, ((Boolean)x).booleanValue() ? "TRUE" : "FALSE", PG_TEXT);
1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357
				}
				else
				{
					throw new PSQLException("postgresql.prep.type");
				}
				break;
			case Types.BINARY:
			case Types.VARBINARY:
				setObject(parameterIndex, x);
				break;
			case Types.OTHER:
1358
				setString(parameterIndex, ((PGobject)x).getValue(), PG_TEXT);
1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380
				break;
			default:
				throw new PSQLException("postgresql.prep.type");
		}
	}

	public void setObject(int parameterIndex, Object x, int targetSqlType) throws SQLException
	{
		setObject(parameterIndex, x, targetSqlType, 0);
	}

	/*
	 * This stores an Object into a parameter.
	 * <p>New for 6.4, if the object is not recognised, but it is
	 * Serializable, then the object is serialised using the
	 * org.postgresql.util.Serialize class.
	 */
	public void setObject(int parameterIndex, Object x) throws SQLException
	{
		if (x == null)
		{
			setNull(parameterIndex, Types.OTHER);
1381
			return ;
1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407
		}
		if (x instanceof String)
			setString(parameterIndex, (String)x);
		else if (x instanceof BigDecimal)
			setBigDecimal(parameterIndex, (BigDecimal)x);
		else if (x instanceof Short)
			setShort(parameterIndex, ((Short)x).shortValue());
		else if (x instanceof Integer)
			setInt(parameterIndex, ((Integer)x).intValue());
		else if (x instanceof Long)
			setLong(parameterIndex, ((Long)x).longValue());
		else if (x instanceof Float)
			setFloat(parameterIndex, ((Float)x).floatValue());
		else if (x instanceof Double)
			setDouble(parameterIndex, ((Double)x).doubleValue());
		else if (x instanceof byte[])
			setBytes(parameterIndex, (byte[])x);
		else if (x instanceof java.sql.Date)
			setDate(parameterIndex, (java.sql.Date)x);
		else if (x instanceof Time)
			setTime(parameterIndex, (Time)x);
		else if (x instanceof Timestamp)
			setTimestamp(parameterIndex, (Timestamp)x);
		else if (x instanceof Boolean)
			setBoolean(parameterIndex, ((Boolean)x).booleanValue());
		else if (x instanceof PGobject)
1408
			setString(parameterIndex, ((PGobject)x).getValue(), PG_TEXT);
1409 1410 1411 1412 1413
		else
			// Try to store java object in database
			setSerialize(parameterIndex, connection.storeObject(x), x.getClass().getName() );
	}

1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431
	/*
	 * Before executing a stored procedure call you must explicitly
	 * call registerOutParameter to register the java.sql.Type of each
	 * out parameter.
	 *
	 * <p>Note: When reading the value of an out parameter, you must use
	 * the getXXX method whose Java type XXX corresponds to the
	 * parameter's registered SQL type.
	 *
	 * ONLY 1 RETURN PARAMETER if {?= call ..} syntax is used
	 *
	 * @param parameterIndex the first parameter is 1, the second is 2,...
	 * @param sqlType SQL type code defined by java.sql.Types; for
	 * parameters of type Numeric or Decimal use the version of
	 * registerOutParameter that accepts a scale value
	 * @exception SQLException if a database-access error occurs.
	 */
	public void registerOutParameter(int parameterIndex, int sqlType) throws SQLException
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443
	{
		if (parameterIndex != 1)
			throw new PSQLException ("postgresql.call.noinout");
		if (!isFunction)
			throw new PSQLException ("postgresql.call.procasfunc", originalSql);

		// functionReturnType contains the user supplied value to check
		// testReturn contains a modified version to make it easier to
		// check the getXXX methods..
		functionReturnType = sqlType;
		testReturn = sqlType;
		if (functionReturnType == Types.CHAR ||
1444
				functionReturnType == Types.LONGVARCHAR)
1445 1446 1447 1448 1449
			testReturn = Types.VARCHAR;
		else if (functionReturnType == Types.FLOAT)
			testReturn = Types.REAL; // changes to streamline later error checking
		returnTypeSet = true;
	}
1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465

	/*
	 * You must also specify the scale for numeric/decimal types:
	 *
	 * <p>Note: When reading the value of an out parameter, you must use
	 * the getXXX method whose Java type XXX corresponds to the
	 * parameter's registered SQL type.
	 *
	 * @param parameterIndex the first parameter is 1, the second is 2,...
	 * @param sqlType use either java.sql.Type.NUMERIC or java.sql.Type.DECIMAL
	 * @param scale a value greater than or equal to zero representing the
	 * desired number of digits to the right of the decimal point
	 * @exception SQLException if a database-access error occurs.
	 */
	public void registerOutParameter(int parameterIndex, int sqlType,
									 int scale) throws SQLException
1466 1467 1468
	{
		registerOutParameter (parameterIndex, sqlType); // ignore for now..
	}
1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509

	/*
	 * An OUT parameter may have the value of SQL NULL; wasNull
	 * reports whether the last value read has this special value.
	 *
	 * <p>Note: You must first call getXXX on a parameter to read its
	 * value and then call wasNull() to see if the value was SQL NULL.
	 * @return true if the last parameter read was SQL NULL
	 * @exception SQLException if a database-access error occurs.
	 */
	public boolean wasNull() throws SQLException
	{
		// check to see if the last access threw an exception
		return (callResult == null);
	}

	/*
	 * Get the value of a CHAR, VARCHAR, or LONGVARCHAR parameter as a
	 * Java String.
	 *
	 * @param parameterIndex the first parameter is 1, the second is 2,...
	 * @return the parameter value; if the value is SQL NULL, the result is null
	 * @exception SQLException if a database-access error occurs.
	 */
	public String getString(int parameterIndex) throws SQLException
	{
		checkIndex (parameterIndex, Types.VARCHAR, "String");
		return (String)callResult;
	}


	/*
	 * Get the value of a BIT parameter as a Java boolean.
	 *
	 * @param parameterIndex the first parameter is 1, the second is 2,...
	 * @return the parameter value; if the value is SQL NULL, the result is false
	 * @exception SQLException if a database-access error occurs.
	 */
	public boolean getBoolean(int parameterIndex) throws SQLException
	{
		checkIndex (parameterIndex, Types.BIT, "Boolean");
1510 1511
		if (callResult == null)
			return false;
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524
		return ((Boolean)callResult).booleanValue ();
	}

	/*
	 * Get the value of a TINYINT parameter as a Java byte.
	 *
	 * @param parameterIndex the first parameter is 1, the second is 2,...
	 * @return the parameter value; if the value is SQL NULL, the result is 0
	 * @exception SQLException if a database-access error occurs.
	 */
	public byte getByte(int parameterIndex) throws SQLException
	{
		checkIndex (parameterIndex, Types.TINYINT, "Byte");
1525 1526
		if (callResult == null)
			return 0;
1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539
		return (byte)((Integer)callResult).intValue ();
	}

	/*
	 * Get the value of a SMALLINT parameter as a Java short.
	 *
	 * @param parameterIndex the first parameter is 1, the second is 2,...
	 * @return the parameter value; if the value is SQL NULL, the result is 0
	 * @exception SQLException if a database-access error occurs.
	 */
	public short getShort(int parameterIndex) throws SQLException
	{
		checkIndex (parameterIndex, Types.SMALLINT, "Short");
1540 1541
		if (callResult == null)
			return 0;
1542 1543
		return (short)((Integer)callResult).intValue ();
	}
1544

1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555

	/*
	 * Get the value of an INTEGER parameter as a Java int.
	 *
	 * @param parameterIndex the first parameter is 1, the second is 2,...
	 * @return the parameter value; if the value is SQL NULL, the result is 0
	 * @exception SQLException if a database-access error occurs.
	 */
	public int getInt(int parameterIndex) throws SQLException
	{
		checkIndex (parameterIndex, Types.INTEGER, "Int");
1556 1557
		if (callResult == null)
			return 0;
1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570
		return ((Integer)callResult).intValue ();
	}

	/*
	 * Get the value of a BIGINT parameter as a Java long.
	 *
	 * @param parameterIndex the first parameter is 1, the second is 2,...
	 * @return the parameter value; if the value is SQL NULL, the result is 0
	 * @exception SQLException if a database-access error occurs.
	 */
	public long getLong(int parameterIndex) throws SQLException
	{
		checkIndex (parameterIndex, Types.BIGINT, "Long");
1571 1572
		if (callResult == null)
			return 0;
1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585
		return ((Long)callResult).longValue ();
	}

	/*
	 * Get the value of a FLOAT parameter as a Java float.
	 *
	 * @param parameterIndex the first parameter is 1, the second is 2,...
	 * @return the parameter value; if the value is SQL NULL, the result is 0
	 * @exception SQLException if a database-access error occurs.
	 */
	public float getFloat(int parameterIndex) throws SQLException
	{
		checkIndex (parameterIndex, Types.REAL, "Float");
1586 1587
		if (callResult == null)
			return 0;
1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600
		return ((Float)callResult).floatValue ();
	}

	/*
	 * Get the value of a DOUBLE parameter as a Java double.
	 *
	 * @param parameterIndex the first parameter is 1, the second is 2,...
	 * @return the parameter value; if the value is SQL NULL, the result is 0
	 * @exception SQLException if a database-access error occurs.
	 */
	public double getDouble(int parameterIndex) throws SQLException
	{
		checkIndex (parameterIndex, Types.DOUBLE, "Double");
1601 1602
		if (callResult == null)
			return 0;
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701
		return ((Double)callResult).doubleValue ();
	}

	/*
	 * Get the value of a NUMERIC parameter as a java.math.BigDecimal
	 * object.
	 *
	 * @param parameterIndex the first parameter is 1, the second is 2,...
	 * @param scale a value greater than or equal to zero representing the
	 * desired number of digits to the right of the decimal point
	 * @return the parameter value; if the value is SQL NULL, the result is null
	 * @exception SQLException if a database-access error occurs.
	 * @deprecated in Java2.0
	 */
	public BigDecimal getBigDecimal(int parameterIndex, int scale)
	throws SQLException
	{
		checkIndex (parameterIndex, Types.NUMERIC, "BigDecimal");
		return ((BigDecimal)callResult);
	}

	/*
	 * Get the value of a SQL BINARY or VARBINARY parameter as a Java
	 * byte[]
	 *
	 * @param parameterIndex the first parameter is 1, the second is 2,...
	 * @return the parameter value; if the value is SQL NULL, the result is null
	 * @exception SQLException if a database-access error occurs.
	 */
	public byte[] getBytes(int parameterIndex) throws SQLException
	{
		checkIndex (parameterIndex, Types.VARBINARY, "Bytes");
		return ((byte [])callResult);
	}


	/*
	 * Get the value of a SQL DATE parameter as a java.sql.Date object
	 *
	 * @param parameterIndex the first parameter is 1, the second is 2,...
	 * @return the parameter value; if the value is SQL NULL, the result is null
	 * @exception SQLException if a database-access error occurs.
	 */
	public java.sql.Date getDate(int parameterIndex) throws SQLException
	{
		checkIndex (parameterIndex, Types.DATE, "Date");
		return (java.sql.Date)callResult;
	}

	/*
	 * Get the value of a SQL TIME parameter as a java.sql.Time object.
	 *
	 * @param parameterIndex the first parameter is 1, the second is 2,...
	 * @return the parameter value; if the value is SQL NULL, the result is null
	 * @exception SQLException if a database-access error occurs.
	 */
	public java.sql.Time getTime(int parameterIndex) throws SQLException
	{
		checkIndex (parameterIndex, Types.TIME, "Time");
		return (java.sql.Time)callResult;
	}

	/*
	 * Get the value of a SQL TIMESTAMP parameter as a java.sql.Timestamp object.
	 *
	 * @param parameterIndex the first parameter is 1, the second is 2,...
	 * @return the parameter value; if the value is SQL NULL, the result is null
	 * @exception SQLException if a database-access error occurs.
	 */
	public java.sql.Timestamp getTimestamp(int parameterIndex)
	throws SQLException
	{
		checkIndex (parameterIndex, Types.TIMESTAMP, "Timestamp");
		return (java.sql.Timestamp)callResult;
	}

	// getObject returns a Java object for the parameter.
	// See the JDBC spec's "Dynamic Programming" chapter for details.
	/*
	 * Get the value of a parameter as a Java object.
	 *
	 * <p>This method returns a Java object whose type coresponds to the
	 * SQL type that was registered for this parameter using
	 * registerOutParameter.
	 *
	 * <P>Note that this method may be used to read datatabase-specific,
	 * abstract data types. This is done by specifying a targetSqlType
	 * of java.sql.types.OTHER, which allows the driver to return a
	 * database-specific Java type.
	 *
	 * <p>See the JDBC spec's "Dynamic Programming" chapter for details.
	 *
	 * @param parameterIndex the first parameter is 1, the second is 2,...
	 * @return A java.lang.Object holding the OUT parameter value.
	 * @exception SQLException if a database-access error occurs.
	 */
	public Object getObject(int parameterIndex)
	throws SQLException
	{
1702
		checkIndex (parameterIndex);
1703 1704 1705
		return callResult;
	}

1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716
	/*
	 * Returns the SQL statement with the current template values
	 * substituted.
	 */
	public String toString()
	{
		synchronized (sbuf)
		{
			sbuf.setLength(0);
			int i;

1717
			for (i = 0 ; i < m_binds.length ; ++i)
1718
			{
1719
				if (m_binds[i] == null)
1720 1721
					sbuf.append( '?' );
				else
1722 1723
					sbuf.append (m_sqlFragments[i]);
				sbuf.append (m_binds[i]);
1724
			}
1725
			sbuf.append(m_sqlFragments[m_binds.length]);
1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738
			return sbuf.toString();
		}
	}

	/*
	 * There are a lot of setXXX classes which all basically do
	 * the same thing.	We need a method which actually does the
	 * set for us.
	 *
	 * @param paramIndex the index into the inString
	 * @param s a string to be stored
	 * @exception SQLException if something goes wrong
	 */
1739
	protected void bind(int paramIndex, Object s, String type) throws SQLException
1740
	{
1741
		if (paramIndex < 1 || paramIndex > m_binds.length)
1742
			throw new PSQLException("postgresql.prep.range");
1743
		if (paramIndex == 1 && isFunction) // need to registerOut instead
1744
			throw new PSQLException ("postgresql.call.funcover");
1745
		m_binds[paramIndex - 1] = s;
1746
		m_bindTypes[paramIndex - 1] = type;
1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767
	}

	/*
	 * Set a parameter to a tablerow-type oid reference.
	 *
	 * @param parameterIndex the first parameter is 1...
	 * @param x the oid of the object from org.postgresql.util.Serialize.store
	 * @param classname the classname of the java object x
	 * @exception SQLException if a database access error occurs
	 */
	private void setSerialize(int parameterIndex, long x, String classname) throws SQLException
	{
		// converts . to _, toLowerCase, and ensures length<32
		String tablename = Serialize.toPostgreSQL( classname );
		DriverManager.println("setSerialize: setting " + x + "::" + tablename );

		// OID reference to tablerow-type must be cast like:  <oid>::<tablename>
		// Note that postgres support for tablerow data types is incomplete/broken.
		// This cannot be just a plain OID because then there would be ambiguity
		// between when you want the oid itself and when you want the object
		// an oid references.
1768
		bind(parameterIndex, Long.toString(x) + "::" + tablename, PG_TEXT );
1769
	}
1770

1771
	/**
1772 1773
	 * this method will turn a string of the form
	 * {? = call <some_function> (?, [?,..]) }
1774
	 * into the PostgreSQL format which is
1775
	 * select <some_function> (?, [?, ...]) as result
1776
	 *
1777
	 */
1778 1779
	private String modifyJdbcCall(String p_sql) throws SQLException
	{
1780 1781 1782 1783 1784 1785
		//Check that this is actually a call which should start with a {
        //if not do nothing and treat this as a standard prepared sql
		if (!p_sql.trim().startsWith("{")) {
			return p_sql;
		}

1786
		// syntax checking is not complete only a few basics :(
1787
		originalSql = p_sql; // save for error msgs..
1788
		String l_sql = p_sql;
1789
		int index = l_sql.indexOf ("="); // is implied func or proc?
1790
		boolean isValid = true;
1791 1792
		if (index != -1)
		{
1793
			isFunction = true;
1794
			isValid = l_sql.indexOf ("?") < index; // ? before =
1795
		}
1796
		l_sql = l_sql.trim ();
1797 1798 1799 1800 1801 1802 1803
		if (l_sql.startsWith ("{") && l_sql.endsWith ("}"))
		{
			l_sql = l_sql.substring (1, l_sql.length() - 1);
		}
		else
			isValid = false;
		index = l_sql.indexOf ("call");
1804
		if (index == -1 || !isValid)
1805
			throw new PSQLException ("postgresql.call.malformed",
1806 1807 1808 1809
									 new Object[]{l_sql, JDBC_SYNTAX});
		l_sql = l_sql.replace ('{', ' '); // replace these characters
		l_sql = l_sql.replace ('}', ' ');
		l_sql = l_sql.replace (';', ' ');
1810

1811 1812 1813
		// this removes the 'call' string and also puts a hidden '?'
		// at the front of the line for functions, this will
		// allow the registerOutParameter to work correctly
1814 1815 1816 1817
		// because in the source sql there was one more ? for the return
		// value that is not needed by the postgres syntax.  But to make
		// sure that the parameter numbers are the same as in the original
		// sql we add a dummy parameter in this case
1818
		l_sql = (isFunction ? "?" : "") + l_sql.substring (index + 4);
1819

1820
		l_sql = "select " + l_sql + " as " + RESULT_COLUMN + ";";
1821
		return l_sql;
1822 1823 1824 1825
	}

	/** helperfunction for the getXXX calls to check isFunction and index == 1
	 */
1826 1827 1828
	protected void checkIndex (int parameterIndex, int type, String getName)
	throws SQLException
	{
1829
		checkIndex (parameterIndex);
1830
		if (type != this.testReturn)
1831
			throw new PSQLException("postgresql.call.wrongget",
1832 1833 1834
									new Object[]{"java.sql.Types=" + testReturn,
												 getName,
												 "java.sql.Types=" + type});
1835 1836 1837 1838 1839
	}
	/** helperfunction for the getXXX calls to check isFunction and index == 1
	 * @param parameterIndex index of getXXX (index)
	 * check to make sure is a function and index == 1
	 */
1840 1841
	private void checkIndex (int parameterIndex) throws SQLException
	{
1842 1843 1844 1845 1846
		if (!isFunction)
			throw new PSQLException("postgresql.call.noreturntype");
		if (parameterIndex != 1)
			throw new PSQLException("postgresql.call.noinout");
	}
1847

1848 1849


1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863
    public void setUseServerPrepare(boolean flag) throws SQLException {
        //Server side prepared statements were introduced in 7.3
        if (connection.haveMinimumServerVersion("7.3")) {
			//If turning server prepared statements off deallocate statement
			//and reset statement name
			if (m_useServerPrepare != flag && !flag)
				((AbstractJdbc1Connection)connection).ExecSQL("DEALLOCATE " + m_statementName);
			m_statementName = null;
			m_useServerPrepare = flag;
		} else {
			//This is a pre 7.3 server so no op this method
			//which means we will never turn on the flag to use server
			//prepared statements and thus regular processing will continue
		}
1864 1865 1866 1867 1868 1869
	}

	public boolean isUseServerPrepare()
	{
		return m_useServerPrepare;
	}
1870 1871


1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882
	private static final String PG_TEXT = "text";
	private static final String PG_INTEGER = "integer";
	private static final String PG_INT2 = "int2";
	private static final String PG_INT8 = "int8";
	private static final String PG_NUMERIC = "numeric";
	private static final String PG_FLOAT = "float";
	private static final String PG_DOUBLE = "double";
	private static final String PG_BOOLEAN = "boolean";
	private static final String PG_DATE = "date";
	private static final String PG_TIME = "time";
	private static final String PG_TIMESTAMPTZ = "timestamptz";
1883 1884


1885
}