/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.drill.exec.store.jdbc;

import org.apache.calcite.plan.RelOptCluster;
import org.apache.calcite.rel.RelNode;
import org.apache.calcite.schema.SchemaPlus;
import org.apache.drill.exec.store.SchemaConfig;

/**
 * Interface for different implementations of databases connected using the
 * JdbcStoragePlugin.
 */
public interface JdbcDialect {

  /**
   * Register the schemas provided by this JdbcDialect implementation under the
   * given parent schema.
   *
   * @param config Configuration for schema objects.
   * @param parent Reference to parent schema.
   */
  void registerSchemas(SchemaConfig config, SchemaPlus parent);

  /**
   * Generate sql from relational expressions.
   *
   * @param cluster An environment for related relational expressions.
   * @param input Relational expressions.
   */
  String generateSql(RelOptCluster cluster, RelNode input);
}
