org.quickperf.sql.annotation.ExpectJdbcBatching Maven / Gradle / Ivy

Go to download
/*
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 *
 * Copyright 2019-2021 the original author or authors.
 */

package org.quickperf.sql.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * The ExpectJdbcBatching annotation that insert, delete, and update statements
 * are processed through JDBC batches of batchSize elements.
 *
 * 


 * Example:
 *  *      @ExpectJdbcBatching(batchSize = 30)
 *      public void insert_using_jdbc_batching_system(){
 *          ..
 *      }
 * 
 *
 * 


 * Note:
 * You may sometimes think that you are using JDBC batching, but in fact, you are not:
 * 
 * 
 * Hibernate
 * batch processing why you may not be using it even if you think you are
 * 
 * 
 * Hibernate disabled insert batching when using an identity identifier
 * 
 * 
 *
 * @see The cost of JDBC Server roundtrips.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface ExpectJdbcBatching {

    /**
     * Specifies a batchSize (integer) to cause the test method to fail if the used batch size is not equal. A zero batch size means that JDBC batching is disabled. With no given batch size value, the
     * annotation will still check that insert, delete and update statements are processed through JDBC batches (but the
     * annotation will not check the batch size).
     */
    int batchSize() default -1;

}