com.datastax.oss.driver.api.core.metadata.schema.IndexMetadata Maven / Gradle / Ivy

/*
 * Copyright DataStax, Inc.
 *
 * Licensed 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.datastax.oss.driver.api.core.metadata.schema;

import com.datastax.oss.driver.api.core.CqlIdentifier;
import com.datastax.oss.driver.internal.core.metadata.schema.ScriptBuilder;
import com.datastax.oss.driver.shaded.guava.common.collect.Maps;
import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.Map;
import java.util.Optional;

/** A secondary index in the schema metadata. */
public interface IndexMetadata extends Describable {

  @NonNull
  CqlIdentifier getKeyspace();

  @NonNull
  CqlIdentifier getTable();

  @NonNull
  CqlIdentifier getName();

  @NonNull
  IndexKind getKind();

  @NonNull
  String getTarget();

  /** If this index is custom, the name of the server-side implementation. Otherwise, empty. */
  @NonNull
  default Optional getClassName() {
    return Optional.ofNullable(getOptions().get("class_name"));
  }

  /**
   * The options of the index.
   *
   * This directly reflects the corresponding column of the system table ({@code
   * system.schema_columns.index_options} in Cassandra <= 2.2, or {@code
   * system_schema.indexes.options} in later versions).
   *
   * Note that some of these options might also be exposed as standalone fields in this
   * interface, namely {@link #getClassName()} and {{@link #getTarget()}}.
   */
  @NonNull
  Map getOptions();

  @NonNull
  @Override
  default String describe(boolean pretty) {
    ScriptBuilder builder = new ScriptBuilder(pretty);
    if (getClassName().isPresent()) {
      builder
          .append("CREATE CUSTOM INDEX ")
          .append(getName())
          .append(" ON ")
          .append(getKeyspace())
          .append(".")
          .append(getTable())
          .append(String.format(" (%s)", getTarget()))
          .newLine()
          .append(String.format("USING '%s'", getClassName().get()));

      // Some options already appear in the CREATE statement, ignore them
      Map describedOptions =
          Maps.filterKeys(getOptions(), k -> !"target".equals(k) && !"class_name".equals(k));
      if (!describedOptions.isEmpty()) {
        builder.newLine().append("WITH OPTIONS = {").newLine().increaseIndent();
        boolean first = true;
        for (Map.Entry option : describedOptions.entrySet()) {
          if (first) {
            first = false;
          } else {
            builder.append(",").newLine();
          }
          builder.append(String.format("'%s' : '%s'", option.getKey(), option.getValue()));
        }
        builder.decreaseIndent().append("}");
      }
    } else {
      builder
          .append("CREATE INDEX ")
          .append(getName())
          .append(" ON ")
          .append(getKeyspace())
          .append(".")
          .append(getTable())
          .append(String.format(" (%s);", getTarget()));
    }
    return builder.build();
  }

  @NonNull
  @Override
  default String describeWithChildren(boolean pretty) {
    // An index has no children
    return describe(pretty);
  }
}