com.hazelcast.org.apache.calcite.model.JsonJdbcSchema Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hazelcast-sql Show documentation
SQL Parser and Optimizer
There is a newer version: 5.5.0
/*
 * 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 com.hazelcast.org.apache.calcite.model;

import com.hazelcast.com.fasterxml.jackson.annotation.JsonCreator;
import com.hazelcast.com.fasterxml.jackson.annotation.JsonProperty;

import com.hazelcast.org.checkerframework.checker.nullness.qual.Nullable;

import java.util.List;

import static java.util.Objects.requireNonNull;

/**
 * JSON object representing a schema that maps to a JDBC database.
 *
 * Like the base class {@link JsonSchema},
 * occurs within {@link JsonRoot#schemas}.
 *
 * @see JsonRoot Description of JSON schema elements
 */
public class JsonJdbcSchema extends JsonSchema {
  /** The name of the JDBC driver class.
   *
   * 
Optional. If not specified, uses whichever class the JDBC
   * {@link java.sql.DriverManager} chooses.
   */
  public final @Nullable String jdbcDriver;

  /** The FQN of the {@link com.hazelcast.org.apache.calcite.sql.SqlDialectFactory} implementation.
   *
   * 
Optional. If not specified, uses whichever class the JDBC
   * {@link java.sql.DriverManager} chooses.
   */
  public final @Nullable String sqlDialectFactory;

  /** JDBC connect string, for example "jdbc:mysql://localhost/foodmart".
   */
  public final String jdbcUrl;

  /** JDBC user name.
   *
   * 
Optional.
   */
  public final @Nullable String jdbcUser;

  /** JDBC connect string, for example "jdbc:mysql://localhost/foodmart".
   *
   * 
Optional.
   */
  public final @Nullable String jdbcPassword;

  /** Name of the initial catalog in the JDBC data source.
   *
   * 
Optional.
   */
  public final @Nullable String jdbcCatalog;

  /** Name of the initial schema in the JDBC data source.
   *
   * 
Optional.
   */
  public final @Nullable String jdbcSchema;

  @JsonCreator
  public JsonJdbcSchema(
      @JsonProperty(value = "name", required = true) String name,
      @JsonProperty("path") @Nullable List