com.google.zetasql.Table Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of zetasql-client Show documentation

Analyzer Framework for SQL

There is a newer version: 2024.11.1

/*
 * Copyright 2019 ZetaSQL Authors
 *
 * 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.google.zetasql;

import com.google.common.collect.ImmutableList;
import java.io.Serializable;

/** A table or table-like object visible in a ZetaSQL query. */
public interface Table extends Serializable {

  /**
   * Get the table name.
   */
  public String getName();

  /**
   * Get a fully-qualified description of this Table.
   * Suitable for log messages, but not necessarily a valid SQL path expression.
   */
  public String getFullName();

  public int getColumnCount();

  public Column getColumn(int i);

  public ImmutableList getColumnList();

  public Column findColumnByName(String name);

  /**
   * If true, this table is a value table, and should act like each row is a single unnamed value
   * with some type rather than acting like each row is a vector of named columns. This can be used
   * to represent inputs where each row is actually one protocol buffer value.
   *
   * The table must have at least one column, and the first column (column 0) is treated as the
   * value of the row. Additional columns may be present but must be pseudo-columns.
   *
   * For more information on value tables, refer to the value tables spec:
   * (broken link)
   */
  public boolean isValueTable();

  public long getId();
}