Documentation
¶
Overview ¶
Package catid is a low-level package exporting ID types.
Index ¶
- func FuncIDToOID(id DescID) oid.Oid
- func IsOIDUserDefined(oid oid.Oid) bool
- func TypeIDToOID(id DescID) oid.Oid
- type ColumnID
- type ConstraintID
- type DescID
- type FamilyID
- type IndexID
- type IndexSet
- func (s *IndexSet) Add(indexID IndexID)
- func (s IndexSet) Contains(indexID IndexID) bool
- func (s IndexSet) Difference(other IndexSet) IndexSet
- func (s IndexSet) Empty() bool
- func (s IndexSet) ForEach(f func(col IndexID))
- func (s IndexSet) Intersection(other IndexSet) IndexSet
- func (s IndexSet) Len() int
- func (s IndexSet) Next(startVal IndexID) (IndexID, bool)
- func (s IndexSet) Ordered() []IndexID
- func (s IndexSet) String() string
- func (s IndexSet) SubsetOf(other IndexSet) bool
- func (s *IndexSet) UnionWith(rhs IndexSet)
- type PGAttributeNum
- type RoleID
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FuncIDToOID ¶
FuncIDToOID converts a function descriptor ID into a function OID.
func IsOIDUserDefined ¶
IsOIDUserDefined returns true if oid is greater than CockroachPredefinedOIDMax, otherwise false.
func TypeIDToOID ¶
TypeIDToOID converts a type descriptor ID into a type OID.
Types ¶
type ConstraintID ¶
type ConstraintID uint32
ConstraintID is a custom type for TableDeascriptor constraint IDs.
func (ConstraintID) SafeValue ¶
func (ConstraintID) SafeValue()
SafeValue implements the redact.SafeValue interface.
type DescID ¶
type DescID uint32
DescID is a custom type for {Database,Table}Descriptor IDs.
const InvalidDescID DescID = 0
InvalidDescID is the uninitialised descriptor id.
func UserDefinedOIDToID ¶
UserDefinedOIDToID converts the OID of a user-defined type or function to a descriptor ID. Returns zero if the OID is not user-defined.
type IndexSet ¶
type IndexSet struct {
// contains filtered or unexported fields
}
IndexSet efficiently stores an unordered set of index ids.
func MakeIndexIDSet ¶
MakeIndexIDSet returns a set initialized with the given values.
func (IndexSet) Difference ¶
Difference returns the index IDs in s which are not in other.
func (IndexSet) Intersection ¶
Intersection returns the intersection between s and other.
func (IndexSet) Next ¶
Next returns the first value in the set which is >= startVal. If there is no value, the second return value is false.
func (IndexSet) Ordered ¶
Ordered returns a slice with all the IndexIDs in the set, in increasing order.
func (IndexSet) String ¶
String returns a list representation of elements. Sequential runs of positive numbers are shown as ranges. For example, for the set {1, 2, 3 5, 6, 10}, the output is "(1-3,5,6,10)".
type PGAttributeNum ¶
type PGAttributeNum uint32
PGAttributeNum is a custom type for Column's logical order.
func (PGAttributeNum) SafeValue ¶
func (PGAttributeNum) SafeValue()
SafeValue implements the redact.SafeValue interface.
Source Files