org.polypheny.prism.IndexOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of polypheny-jdbc-driver Show documentation
A standards-compliant JDBC driver for Polypheny-DB.
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: org/polypheny/prism/namespace_meta_responses.proto

package org.polypheny.prism;

public interface IndexOrBuilder extends
    // @@protoc_insertion_point(interface_extends:org.polypheny.prism.Index)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    *
   *The namespace or schema of the indexed table.
   *This indicates the specific namespace or schema within the database where the indexed table resides.
   * 
   *
   * string namespace_name = 2;
   * @return The namespaceName.
   */
  java.lang.String getNamespaceName();
  /**
   *    *
   *The namespace or schema of the indexed table.
   *This indicates the specific namespace or schema within the database where the indexed table resides.
   * 
   *
   * string namespace_name = 2;
   * @return The bytes for namespaceName.
   */
  com.google.protobuf.ByteString
      getNamespaceNameBytes();

  /**
   *    *
   *The table on which the index is defined.
   *This field identifies the specific table within the namespace that the index belongs to.
   * 
   *
   * string table_name = 3;
   * @return The tableName.
   */
  java.lang.String getTableName();
  /**
   *    *
   *The table on which the index is defined.
   *This field identifies the specific table within the namespace that the index belongs to.
   * 
   *
   * string table_name = 3;
   * @return The bytes for tableName.
   */
  com.google.protobuf.ByteString
      getTableNameBytes();

  /**
   *    *
   *Indicates if the index enforces unique values.
   *A boolean value where true means the index ensures that all values in the index are unique.
   * 
   *
   * bool unique = 4;
   * @return The unique.
   */
  boolean getUnique();

  /**
   *    *
   *The name of the index.
   *This allows for the naming of the index for easier reference and management within the database.
   * 
   *
   * string index_name = 5;
   * @return The indexName.
   */
  java.lang.String getIndexName();
  /**
   *    *
   *The name of the index.
   *This allows for the naming of the index for easier reference and management within the database.
   * 
   *
   * string index_name = 5;
   * @return The bytes for indexName.
   */
  com.google.protobuf.ByteString
      getIndexNameBytes();

  /**
   *    *
   *The columns that are part of the index.
   *This repeated field lists all the columns included in the index, defining the order and structure of the index.
   * 
   *
   * repeated .org.polypheny.prism.Column columns = 6;
   */
  java.util.List 
      getColumnsList();
  /**
   *    *
   *The columns that are part of the index.
   *This repeated field lists all the columns included in the index, defining the order and structure of the index.
   * 
   *
   * repeated .org.polypheny.prism.Column columns = 6;
   */
  org.polypheny.prism.Column getColumns(int index);
  /**
   *    *
   *The columns that are part of the index.
   *This repeated field lists all the columns included in the index, defining the order and structure of the index.
   * 
   *
   * repeated .org.polypheny.prism.Column columns = 6;
   */
  int getColumnsCount();
  /**
   *    *
   *The columns that are part of the index.
   *This repeated field lists all the columns included in the index, defining the order and structure of the index.
   * 
   *
   * repeated .org.polypheny.prism.Column columns = 6;
   */
  java.util.List 
      getColumnsOrBuilderList();
  /**
   *    *
   *The columns that are part of the index.
   *This repeated field lists all the columns included in the index, defining the order and structure of the index.
   * 
   *
   * repeated .org.polypheny.prism.Column columns = 6;
   */
  org.polypheny.prism.ColumnOrBuilder getColumnsOrBuilder(
      int index);

  /**
   *    *
   *A numeric identifier representing the location or storage of the index.
   *This field is used to identify where the index is physically stored within the database system, if applicable.
   * 
   *
   * int64 location = 8;
   * @return The location.
   */
  long getLocation();

  /**
   *    *
   *A numeric representation indicating the type or mechanism of the index.
   *This could represent different types of indexing strategies used by the database system, such as B-tree, hash, etc.
   * 
   *
   * int32 index_type = 9;
   * @return The indexType.
   */
  int getIndexType();
}