github.com/cockroachdb/cockroach@v20.2.0-alpha.1+incompatible/pkg/sql/opt/cat/sequence.go (about)

     1  // Copyright 2018 The Cockroach Authors.
     2  //
     3  // Use of this software is governed by the Business Source License
     4  // included in the file licenses/BSL.txt.
     5  //
     6  // As of the Change Date specified in that file, in accordance with
     7  // the Business Source License, use of this software will be governed
     8  // by the Apache License, Version 2.0, included in the file
     9  // licenses/APL.txt.
    10  
    11  package cat
    12  
    13  import "github.com/cockroachdb/cockroach/pkg/util/treeprinter"
    14  
    15  // Sequence is an interface to a database sequence.
    16  type Sequence interface {
    17  	DataSource
    18  
    19  	// SequenceMarker is a dummy method, included as a safety measure so that
    20  	// every DataSource does not trivially implement Sequence.
    21  	SequenceMarker()
    22  }
    23  
    24  // FormatSequence nicely formats a catalog sequence using a treeprinter for
    25  // debugging and testing.
    26  func FormatSequence(cat Catalog, seq Sequence, tp treeprinter.Node) {
    27  	tp.Childf("SEQUENCE %s", seq.Name())
    28  }