1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.shardingsphere.infra.executor.sql.hook;
19
20 import org.apache.shardingsphere.infra.database.core.connector.ConnectionProperties;
21
22 import java.util.List;
23
24 /**
25 * SQL Execution hook.
26 */
27 public interface SQLExecutionHook {
28
29 /**
30 * Handle when SQL execution started.
31 *
32 * @param dataSourceName data source name
33 * @param sql SQL
34 * @param params SQL parameters
35 * @param connectionProps connection properties
36 * @param isTrunkThread is execution in trunk thread
37 */
38 void start(String dataSourceName, String sql, List<Object> params, ConnectionProperties connectionProps, boolean isTrunkThread);
39
40 /**
41 * Handle when SQL execution finished success.
42 */
43 void finishSuccess();
44
45 /**
46 * Handle when SQL execution finished failure.
47 *
48 * @param cause failure cause
49 */
50 void finishFailure(Exception cause);
51 }