core/src/main/java/org/apache/calcite/avatica/util/Quoting.java

/*
 * 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.calcite.avatica.util;

/** Syntax for quoting identifiers in SQL statements. */
public enum Quoting {
  /** Quote identifiers in double-quotes, and use double-quote to escape
   * double-quotes. For example, {@code "my ""id"""}. */
  DOUBLE_QUOTE("\""),

  /** Quote identifiers in double-quotes, and use backslash to escape
   * double-quotes. For example, {@code "my \"id\""}. */
  DOUBLE_QUOTE_BACKSLASH("\""),

  /** Quote identifiers in single-quotes, and use single-quotes to escape
   * single-quotes. For example, {@code 'my ''id'''}. */
  SINGLE_QUOTE("`"),

  /** Quote identifiers in single-quotes, and use backslash to escape
   * single-quotes. For example, {@code 'my \'id\''}. */
  SINGLE_QUOTE_BACKSLASH("`"),

  /** Quote identifiers in back-quotes, and use back-quotes to escape
   * back-quotes. For example, {@code `my ``id```}. */
  BACK_TICK("`"),

  /** Quote identifiers in back-quotes, and use backslash to escape
   * back-quotes. For example, {@code `my \`id\``}. */
  BACK_TICK_BACKSLASH("`"),

  /** Quote identifiers in brackets. For example, {@code [my id]}. */
  BRACKET("[");

  public String string;

  Quoting(String string) {
    this.string = string;
  }
}

// End Quoting.java