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.sqltranslator.spi;
19
20 import org.apache.shardingsphere.database.connector.core.type.DatabaseType;
21 import org.apache.shardingsphere.infra.algorithm.core.ShardingSphereAlgorithm;
22 import org.apache.shardingsphere.infra.metadata.database.ShardingSphereDatabase;
23 import org.apache.shardingsphere.infra.metadata.database.rule.RuleMetaData;
24 import org.apache.shardingsphere.infra.session.query.QueryContext;
25 import org.apache.shardingsphere.sqltranslator.context.SQLTranslatorContext;
26
27 import java.util.List;
28
29 /**
30 * SQL translator.
31 */
32 public interface SQLTranslator extends ShardingSphereAlgorithm {
33
34 /**
35 * Translate SQL.
36 *
37 * @param sql to be translated SQL
38 * @param parameters to be translated parameters
39 * @param queryContext query context
40 * @param storageType storage type
41 * @param database database
42 * @param globalRuleMetaData global rule meta data
43 * @return SQL translator context
44 */
45 SQLTranslatorContext translate(String sql, List<Object> parameters, QueryContext queryContext, DatabaseType storageType, ShardingSphereDatabase database, RuleMetaData globalRuleMetaData);
46 }