cbim

Documentation

Index

• Constants
• func GenerateYaml(indexSet *couchbasev1beta1.CouchbaseIndexSet, ...) (string, error)
• type GlobalSecondaryIndexIdentifier
  • func GetIndexIdentifier(index couchbasev1beta1.GlobalSecondaryIndex) GlobalSecondaryIndexIdentifier
  • func ParseIndexIdentifierString(identifier string) (GlobalSecondaryIndexIdentifier, error)
  • func (identifier GlobalSecondaryIndexIdentifier) IsDefaultCollection() bool
  • func (identifier GlobalSecondaryIndexIdentifier) ToString() string
• type IndexSpec
• type LifecycleSpec
• type PartitionSpec

Constants

const (
	StrategyHash = "hash"
)

Functions

func GenerateYaml

func GenerateYaml(indexSet *couchbasev1beta1.CouchbaseIndexSet, deletingIndexes *[]GlobalSecondaryIndexIdentifier) (string, error)

Types

type GlobalSecondaryIndexIdentifier

type GlobalSecondaryIndexIdentifier struct {
	// Name of the index
	Name string
	// Name of the index's scope
	ScopeName string
	// Name of the index's collection
	CollectionName string
}

Uniquely defines a global secondary index.

func GetIndexIdentifier

func GetIndexIdentifier(index couchbasev1beta1.GlobalSecondaryIndex) GlobalSecondaryIndexIdentifier

func ParseIndexIdentifierString

func ParseIndexIdentifierString(identifier string) (GlobalSecondaryIndexIdentifier, error)

func (GlobalSecondaryIndexIdentifier) IsDefaultCollection

func (identifier GlobalSecondaryIndexIdentifier) IsDefaultCollection() bool

func (GlobalSecondaryIndexIdentifier) ToString

func (identifier GlobalSecondaryIndexIdentifier) ToString() string

type IndexSpec

type IndexSpec struct {
	Type               string         `json:"type,omitempty"`
	Name               string         `json:"name"`
	Scope              *string        `json:"scope,omitempty"`
	Collection         *string        `json:"collection,omitempty"`
	IsPrimary          *bool          `json:"is_primary,omitempty"`
	IndexKey           *[]string      `json:"index_key,omitempty"`
	Condition          *string        `json:"condition,omitempty"`
	RetainDeletedXattr *bool          `json:"retain_deleted_xattr,omitempty"`
	Partition          *PartitionSpec `json:"partition,omitempty"`
	ManualReplica      *bool          `json:"manual_replica,omitempty"`
	NumReplicas        *int           `json:"num_replica,omitempty"`
	Nodes              *[]string      `json:"nodes,omitempty"`
	Lifecycle          *LifecycleSpec `json:"lifecycle,omitempty"`
}

type LifecycleSpec

type LifecycleSpec struct {
	Drop *bool `json:"drop,omitempty"`
}

type PartitionSpec

type PartitionSpec struct {
	Expressions   []string `json:"exprs"`
	Strategy      *string  `json:"strategy,omitempty"`
	NumPartitions *int     `json:"num_partition,omitempty"`
}