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.sharding.spi;
19
20 import org.apache.shardingsphere.infra.algorithm.core.ShardingSphereAlgorithm;
21
22 import java.util.Optional;
23
24 /**
25 * Sharding algorithm.
26 */
27 public interface ShardingAlgorithm extends ShardingSphereAlgorithm {
28
29 /**
30 * Get algorithm structure.
31 *
32 * @param dataNodePrefix data node prefix
33 * @param shardingColumn sharding column
34 * @return algorithm structure
35 */
36 default Optional<String> getAlgorithmStructure(final String dataNodePrefix, final String shardingColumn) {
37 return Optional.empty();
38 }
39 }