Running SQL Statements

Running a Common SQL Statement

SQL statements are run on applications to operate database. Operations such as SELECT, UPDATE, INSERT, and DELETE can be performed on XML data.

The prerequisite is that you have connected to the database using the connection object conn. Create the customer_t1 table as follows:

1. Create a statement object by calling the createStatement method of the Connection API.

   1	Statement stmt = conn.createStatement();

2. Run the SQL statement by calling the executeUpdate method of the Statement API.

   1	int rc = stmt.executeUpdate("CREATE TABLE customer_t1(c_customer_sk INTEGER, c_customer_name VARCHAR(32));");

3. Close the statement object stmt by calling the close method of the Statement API.

   1	stmt.close();

• If an execution request (not in a transaction block) received in the database contains multiple statements, the request is packed into a transaction. The VACUUM operation is not supported in a transaction block. If one of the statements fails, the entire request will be rolled back.

• Use semicolons (;) to separate statements. Stored procedures, functions, and anonymous blocks do not support multi-statement execution. When preferQueryMode is set to simple, the statement does not execute the parsing logic, and the semicolons (;) cannot be used to separate statements in this scenario.
• The slash (/) can be used as the terminator for creating a single stored procedure, function, anonymous block, or package body. When preferQueryMode is set to simple, the statement does not execute the parsing logic, and the slash (/) cannot be used as the terminator in this scenario.
• JDBC caches SQL statements in PreparedStatement, which may cause memory bloat. If the JVM memory is small, you are advised to adjust preparedStatementCacheSizeMiB or preparedStatementCacheQueries.

Executing a Prepared Statement for Insertion

When a prepared statement processes multiple pieces of similar data, the database creates only one execution plan. This improves compilation and optimization efficiency.

The prerequisite is that the customer_t1 table has been created by executing the preceding basic SQL statements. Execute the prepared statement to insert data in batches as follows:

1. Create the prepared statement object pst by calling the prepareStatement method of the Connection API.

   1	PreparedStatement pst = conn.prepareStatement("INSERT INTO customer_t1 VALUES (?,?)");

2. Call the corresponding API to set parameters for each piece of data and call addBatch to add SQL statements to the batch processing.

   1 2 3 4 5

   for (int i = 0; i < 3; i++) { pst.setInt(1, i); pst.setString(2, "data " + i); pst.addBatch(); }

3. Perform batch processing by calling the executeBatch method of the PreparedStatement API.

   1	pst.executeBatch();

4. Close the prepared statement object pst by calling the close method of the PreparedStatement API.

   1	pst.close();

Do not terminate a batch processing action when it is ongoing; otherwise, database performance will deteriorate. You need to disable automatic commit during batch processing and manually commit several rows at a time. The statement for disabling automatic commit is as follows:

conn.setAutoCommit(false);

Executing a Prepared Statement for Update

Prepared statements are complied and optimized once but can be used in different scenarios by assigning multiple values. Using prepared statements improves execution efficiency. If you want to run a statement for several times, use a prepared statement.

The prerequisite is that the preceding prepared statement has been executed and data has been inserted into the customer_t1 table in batches. Execute the prepared SQL statement to update data as follows:

1. Create the prepared statement object pstmt by calling the prepareStatement method of the Connection API.

   1	PreparedStatement pstmt = conn.prepareStatement("UPDATE customer_t1 SET c_customer_name = ? WHERE c_customer_sk = 1");

2. Set parameters by calling the setString method of the PreparedStatement API.

   1	pstmt.setString(1, "new Data");

3. Execute the prepared statement by calling the executeUpdate method of the PreparedStatement API.

   1	int rowcount = pstmt.executeUpdate();

4. Close the prepared statement object pstmt by calling the close method of the PreparedStatement API.

   1	pstmt.close();

After binding parameters are set in PrepareStatement, a B packet or U packet is constructed and sent to the server when the SQL statement is executed. However, the maximum length of a B packet or U packet cannot exceed 1023 MB. If the data bound at a time is too large, an exception may occur because the packet is too long. Therefore, when setting binding parameters in PrepareStatement, you need to evaluate and control the size of the bound data to avoid exceeding the upper packet limit.

Creating and Calling a Stored Procedure

GaussDB can call stored procedures through JDBC. The prerequisite is that the database connection is established and the connection object is conn.

Create the testproc stored procedure as follows:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

// Create the stored procedure (containing the OUT parameter) in the database as follows:
create or replace procedure testproc 
(
    psv_in1 in integer,
    psv_in2 in integer,
    psv_inout inout integer
)
as
begin
    psv_inout := psv_in1 + psv_in2 + psv_inout;
end;
/

Call the testproc stored procedure as follows:

1. Create a call statement object cstmt by calling the prepareCall method of Connection.

   1	CallableStatement cstmt = conn.prepareCall("{? = CALL TESTPROC(?,?,?)}");

2. Set parameters by calling the setInt method of CallableStatement.

   1 2 3

   cstmt.setInt(2, 50); cstmt.setInt(1, 20); cstmt.setInt(3, 90);

3. Register an output parameter by calling the registerOutParameter method of CallableStatement.

   1	cstmt.registerOutParameter(4, Types.INTEGER); // Register an OUT parameter of the integer type.

4. Execute SQL statements by calling the execute method of CallableStatement.

   1	cstmt.execute();

5. Obtain the out parameter by calling the getInt method of CallableStatement.

   1	int out = cstmt.getInt(4);

6. Close the call statement object cstmt by calling the close method of CallableStatement.

   1	cstmt.close();

• If JDBC is used to call a stored procedure whose returned value is a cursor, the returned cursor cannot be used.
• A stored procedure and an SQL statement must be run separately.
• Output parameters must be registered for parameters of the inout type in the stored procedure.

• Many database classes such as Connection, Statement, and ResultSet have a close() method. Close these classes after using their objects. Closing Connection objects will close all the related Statements objects, and closing a Statement object will close its ResultSet object.
• Some JDBC drivers support named parameters, which can be used to set parameters by name rather than sequence. If a parameter has the default value, you do not need to specify any parameter value but can use the default value directly. Even though the parameter sequence changes during a stored procedure, the application does not need to be modified. Currently, the GaussDB JDBC driver does not support this method.
• GaussDB does not support functions containing OUT parameters, or stored procedures and function parameters containing default values.
• When you bind parameters in conn.prepareCall("{? = CALL TESTPROC(?,?,?)}") during a stored procedure calling, you can bind parameters and register the first parameter as the output parameter according to the placeholder sequence or the fourth parameter as the output parameter according to the parameter sequence in the stored procedure. The preceding example registers the fourth parameter.

Creating and Calling a Stored Procedure (Input Parameters of the Composite Data Type)

The following shows how to create and call a stored procedure whose input parameters are of the composite data type in A-compatible mode. The prerequisite is that the database connection is established and the connection object is conn.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

// Create a composite data type in the database.
CREATE TYPE compfoo AS (f1 int, f3 text);
// Create the table type in the database.
create type compfoo_table is table of compfoo;
// Create the following stored procedure (containing the OUT parameter) in the database:
create or replace procedure test_proc
(
    psv_in in compfoo,
    table_in in compfoo_table,
    psv_out out compfoo,
    table_out out compfoo_table
)
as
begin
    psv_out := psv_in;
    table_out:=compfoo_table();
    table_out.extend(table_in.count);
    for i in 1..table_in.count loop
         table_out(i):=table_in(i);
    end loop;
end;
/

Call the test_proc stored procedure as follows:

1. After the behavior_compat_options is set to 'proc_outparam_override', create the call statement object cs by calling the prepareCall method of Connection.

   1 2 3

   Statement statement = conn.createStatement(); statement.execute("set behavior_compat_options='proc_outparam_override'"); CallableStatement cs = conn.prepareCall("{ CALL TEST_PROC(?,?,?,?) }");

2. Set parameters by calling the set method of CallableStatement.

   1 2 3 4 5 6 7 8

   PGobject pGobject = new PGobject(); pGobject.setType("public.compfoo"); // Set the composite type name. The format is "schema.typename". pGobject.setValue("(1,demo)"); //: Bind the value of the composite type. The format is "(value1,value2)". cs.setObject(1, pGobject); pGobject = new PGobject(); pGobject.setType("public.compfoo_table"); // Set the Table type name. The format is "schema.typename". pGobject.setValue("{\"(10,demo10)\",\"(11,demo111)\"}"); // Bind the value of the Table type. The format is "{\"(value1,value2)\",\"(value1,value2)\",...}". cs.setObject(2, pGobject);

3. Register an output parameter by calling the registerOutParameter method of CallableStatement.

   1 2 3 4

   // Register an OUT parameter of the composite type. The format is "schema.typename". cs.registerOutParameter(3, Types.STRUCT, "public.compfoo"); // Register an OUT parameter of the table type. The format is "schema.typename". cs.registerOutParameter(4, Types.ARRAY, "public.compfoo_table");

4. Execute SQL statements by calling the execute method of CallableStatement.

   1	cs.execute();

5. Obtain the output parameter by calling the getObject method of CallableStatement.

   1 2 3 4 5 6 7 8 9 10 11 12

   // The returned structure is of the user-defined type. PGobject result = (PGobject)cs.getObject(3); // Obtain the out parameter. result.getValue(); // Obtain the string value of the composite type. result.getArrayValue(); // Obtain the array values of the composite type and sort the values according to the sequence of columns of the composite type. result.getStruct(); // Obtain the subtype names of the composite type and sort them according to the creation sequence. result.getAttributes(); // Return the object constructed from data in each column of the user-defined type. For the array and table types, PgArray is returned. For the user-defined type, PGobject is encapsulated. For other types of data, a character string is returned. // The returned result is of the table type. PgArray pgArray = (PgArray) cs.getObject(4); ResultSet rs = pgArray.getResultSet(); while (rs.next()) { rs.getObject(2);// Object constructed from data in each row of the table type. }

   

   If the table type of the output parameter is user-defined, for example, defined by running create type compfoo_table is table of compfoo, the received return object is PgArray. In addition, the object obtained by rs.getObject(2) is also PgArray. In this case, the data of each column of the compfoo type cannot be obtained. To obtain the data, you must execute getPGobject() to obtain PgObject first.

6. Close the call statement object cs by calling the close method of CallableStatement.

   1	cs.close();

• After the A-compatible mode is enabled, you must use the {call proc_name(?,?,?)} format to call a stored procedure and use the {? = call func_name(?,?)} format to call a function. The question mark (?) on the left of the equal mark is the placeholder for the return value of the function and is used to register the return value of the function.
• After behavior_compat_options is set to 'proc_outparam_override', the service needs to re-establish a connection. Otherwise, the stored procedures and functions cannot be correctly called.
• If a function or stored procedure contains a composite type, bind and register parameters in the schema.typename format.