Class InsertClause

tests/comparison/query.py:703–767

class InsertClause(object):

  # This enum represents possibilities for different types of INSERTs. A user of this
  # object, like StatementGenerator, is responsible for setting the conflict_action
  # value appropriately. These values are valid for the conflict_action parameter.
  # Because an InsertStatement is a single piece of data shared across multiple SQL
  # dialects, this setting can alter the written SQL in multiple dialects.
  #
  # CONLICT_ACTION_DEFAULT
  #
  # For Impala, this is a statement like INSERT INTO hdfs_table SELECT * FROM foo
  # For PostgreSQL, this is a statement like INSERT INTO hdfs_table SELECT * FROM foo
  #
  # Example uses cases: inserting into tables that do not have primary keys, or
  # inserting into PostgreSQL tables where you want to error if there are attempts to
  # insert duplicate primary keys
  #
  # CONFLICT_ACTION_IGNORE
  #
  # For Impala, this is a statement like INSERT INTO kudu_table SELECT * FROM foo
  # For PostgreSQL, this is a statement like INSERT INTO kudu_table SELECT * FROM foo
  #                                          ON CONFLICT DO NOTHING
  #
  # Example use case: inserting into Kudu tables, where attempts to insert duplicate
  # primary key rows are ignored by Impala, so they must also be ignored by PostgreSQL.
  # Note that the *syntax* for INSERT doesn't change with Impala, but because it's a
  # Kudu table, the behavior differs.
  #
  # CONFLICT_ACTION_UPDATE
  #
  # For Impala, this is a statement like UPSERT INTO kudu_table SELECT * FROM foo
  # For PostgreSQL, this is a statement like INSERT INTO kudu_table SELECT * FROM foo
  #                                          ON CONFLICT DO UPDATE SET
  #                                          (col1 = EXCLUDED.col1, ...)
  #
  # Example use case: upserting into Kudu tables, where attempts to insert duplicate
  # primary key rows will either insert a single row, or update a single row already
  # there, without error. In PostgreSQL, UPSERT is written via this "ON CONFLICT DO
  # UPDATE" clause.
  #
  # More on PostgreSQL INSERT/UPSERT syntax here:
  # https://www.postgresql.org/docs/9.5/static/sql-insert.html

  (CONFLICT_ACTION_DEFAULT,
   CONFLICT_ACTION_IGNORE,
   CONFLICT_ACTION_UPDATE) = range(3)

  def __init__(self, table, column_list=None, conflict_action=CONFLICT_ACTION_DEFAULT):
    """
    Represent an INSERT/UPSERT clause, which is the first half of an INSERT/UPSERT
    statement. Note that UPSERTs are very similar to INSERTs, so this data structure can
    easily deal with both.

    The table is a Table object.

    column_list is an optional list, tuple, or other sequence of
    tests.comparison.common.Column objects. In an Impala INSERT/UPSERT SQL statement,
    it's a sequence of column names. See