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.proxy.backend.response.header.query;
19
20 import org.apache.shardingsphere.infra.executor.sql.execute.result.query.QueryResultMetaData;
21 import org.apache.shardingsphere.infra.metadata.database.ShardingSphereDatabase;
22 import org.apache.shardingsphere.infra.database.core.spi.DatabaseTypedSPI;
23 import org.apache.shardingsphere.infra.spi.annotation.SingletonSPI;
24
25 import java.sql.SQLException;
26
27 /**
28 * Query header builder.
29 */
30 @SingletonSPI
31 public interface QueryHeaderBuilder extends DatabaseTypedSPI {
32
33 /**
34 * Build query header.
35 *
36 * @param queryResultMetaData query result meta data
37 * @param database database
38 * @param columnName column name
39 * @param columnLabel column label
40 * @param columnIndex column index
41 * @return query header
42 * @throws SQLException SQL exception
43 */
44 QueryHeader build(QueryResultMetaData queryResultMetaData, ShardingSphereDatabase database, String columnName, String columnLabel, int columnIndex) throws SQLException;
45 }