All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.hsqldb.Statement Maven / Gradle / Ivy

There is a newer version: 2.7.4
Show newest version
/* Copyright (c) 2001-2020, The HSQL Development Group
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * Neither the name of the HSQL Development Group nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL HSQL DEVELOPMENT GROUP, HSQLDB.ORG,
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */


package org.hsqldb;

import org.hsqldb.HsqlNameManager.HsqlName;
import org.hsqldb.ParserDQL.CompileContext;
import org.hsqldb.error.Error;
import org.hsqldb.error.ErrorCode;
import org.hsqldb.lib.OrderedHashSet;
import org.hsqldb.result.Result;
import org.hsqldb.result.ResultMetaData;
import org.hsqldb.result.ResultProperties;

/**
 * Base class for compiled statement objects.

* * @author Fred Toussi (fredt@users dot sourceforge.net) * @version 2.4.0 * @since 1.9.0 */ public abstract class Statement { static final int META_RESET_VIEWS = 1; static final int META_RESET_STATEMENTS = 2; // static final Statement[] emptyArray = new Statement[]{}; // final int type; int group; boolean isLogged = true; boolean isValid = true; int statementReturnType = StatementTypes.RETURN_COUNT; /** the default schema name used to resolve names in the sql */ HsqlName schemaName; /** root in PSM */ Routine root; /** parent in PSM */ StatementCompound parent; boolean isError; boolean isTransactionStatement; boolean isExplain; /** SQL string for the statement */ String sql; /** id in StatementManager */ long id; /** compileTimestamp */ long compileTimestamp; /** table names read - for concurrency control */ HsqlName[] readTableNames = HsqlName.emptyArray; /** table names written - for concurrency control */ HsqlName[] writeTableNames = HsqlName.emptyArray; // OrderedHashSet references; // int cursorPropertiesRequest; /** * Parse-order array of Expression objects, all of type PARAMETER , * involved in some way in any INSERT_XXX, UPDATE, DELETE, SELECT or * CALL CompiledStatement */ ExpressionColumn[] parameters; /** * ResultMetaData for parameters */ ResultMetaData parameterMetaData = ResultMetaData.emptyParamMetaData; static final String PCOL_PREFIX = "@p"; static final String RETURN_COLUMN_NAME = "@p0"; public abstract Result execute(Session session); public void setParameters(ExpressionColumn[] params) {} Statement(int type) { this.type = type; } Statement(int type, int group) { this.type = type; this.group = group; } public final boolean isError() { return isError; } public boolean isTransactionStatement() { return isTransactionStatement; } public boolean isAutoCommitStatement() { return false; } public void setCompileTimestamp(long ts) { compileTimestamp = ts; } public long getCompileTimestamp() { return compileTimestamp; } public final void setSQL(String sql) { this.sql = sql; } public String getSQL() { return sql; } public OrderedHashSet getReferences() { return references; } public final void setDescribe() { isExplain = true; } public abstract String describe(Session session); public HsqlName getSchemaName() { return schemaName; } public final void setSchemaHsqlName(HsqlName name) { schemaName = name; } public final void setID(long csid) { id = csid; } public final long getID() { return id; } public final int getType() { return type; } public final int getGroup() { return group; } public final boolean isValid() { return isValid; } public final boolean isLogged() { return isLogged; } public void clearVariables() {} public void resolve(Session session) {} public final HsqlName[] getTableNamesForRead() { return readTableNames; } public final HsqlName[] getTableNamesForWrite() { return writeTableNames; } public boolean isCatalogLock(int model) { switch (group) { case StatementTypes.X_SQL_SCHEMA_MANIPULATION : // in MVCC log replay statement is not followed by COMMIT so no lock if (type == StatementTypes.ALTER_SEQUENCE) { return false; } if (writeTableNames.length == 0) { return false; } return model == TransactionManager.MVCC; case StatementTypes.X_SQL_SCHEMA_DEFINITION : return model == TransactionManager.MVCC; case StatementTypes.X_HSQLDB_SCHEMA_MANIPULATION : case StatementTypes.X_HSQLDB_DATABASE_OPERATION : return true; case StatementTypes.X_HSQLDB_NONBLOCK_OPERATION : default : return false; } } public boolean isCatalogChange() { switch (group) { case StatementTypes.X_SQL_SCHEMA_DEFINITION : case StatementTypes.X_SQL_SCHEMA_MANIPULATION : case StatementTypes.X_HSQLDB_SCHEMA_MANIPULATION : return true; default : return false; } } public void setParent(StatementCompound statement) { this.parent = statement; } public void setRoot(Routine root) { this.root = root; } public boolean hasGeneratedColumns() { return false; } public ResultMetaData generatedResultMetaData() { return null; } public void setGeneratedColumnInfo(int mode, ResultMetaData meta) {} public ResultMetaData getResultMetaData() { return ResultMetaData.emptyResultMetaData; } public ResultMetaData getParametersMetaData() { return this.parameterMetaData; } public int getResultProperties() { return ResultProperties.defaultPropsValue; } public int getStatementReturnType() { return statementReturnType; } public int getCursorPropertiesRequest() { return cursorPropertiesRequest; } public void setCursorPropertiesRequest(int props) { cursorPropertiesRequest = props; } public void clearStructures(Session session) {} void setDatabaseObjects(Session session, CompileContext compileContext) { parameters = compileContext.getParameters(); setParameterMetaData(); } void setParameterMetaData() { int offset; int idx; boolean hasReturnValue; offset = 0; if (parameters.length == 0) { parameterMetaData = ResultMetaData.emptyParamMetaData; return; } // NO: Not yet // hasReturnValue = (type == CALL && !expression.isProcedureCall()); // // if (hasReturnValue) { // outlen++; // offset = 1; // } parameterMetaData = ResultMetaData.newParameterMetaData(parameters.length); // NO: Not yet // if (hasReturnValue) { // e = expression; // out.sName[0] = DIProcedureInfo.RETURN_COLUMN_NAME; // out.sClassName[0] = e.getValueClassName(); // out.colType[0] = e.getDataType(); // out.colSize[0] = e.getColumnSize(); // out.colScale[0] = e.getColumnScale(); // out.nullability[0] = e.nullability; // out.isIdentity[0] = false; // out.paramMode[0] = expression.PARAM_OUT; // } for (int i = 0; i < parameters.length; i++) { idx = i + offset; // always i + 1. We currently use the convention of @p0 to name the // return value OUT parameter parameterMetaData.columnLabels[idx] = StatementDMQL.PCOL_PREFIX + (i + 1); parameterMetaData.columnTypes[idx] = parameters[i].dataType; if (parameters[i].dataType == null) { throw Error.error(ErrorCode.X_42567); } byte parameterMode = SchemaObject.ParameterModes.PARAM_IN; if (parameters[i].column != null && parameters[i].column.getParameterMode() != SchemaObject.ParameterModes.PARAM_UNKNOWN) { parameterMode = parameters[i].column.getParameterMode(); } parameterMetaData.paramModes[idx] = parameterMode; parameterMetaData.paramNullable[idx] = parameters[i].column == null ? SchemaObject.Nullability.NULLABLE : parameters[i].column.getNullability(); } } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy