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