vindexes

package
v0.20.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 3, 2024 License: Apache-2.0 Imports: 40 Imported by: 18

Documentation

Index

Constants

View Source 
const (
	TypeTable     = ""
	TypeSequence  = "sequence"
	TypeReference = "reference"
)

The following constants represent table types.

Variables

View Source 
var TabletTypeSuffix = map[topodatapb.TabletType]string{
	0: "@unknown",
	1: "@primary",
	2: "@replica",
	3: "@rdonly",
	4: "@spare",
	5: "@experimental",
	6: "@backup",
	7: "@restore",
	8: "@drained",
}

TabletTypeSuffix maps the tablet type to its suffix string.

Functions

func ChooseVindexForType 

func ChooseVindexForType(typ querypb.Type) (string, error)

ChooseVindexForType chooses the most appropriate vindex type for the given SQL data type.

func DeleteAction added in v0.18.0 

func DeleteAction(fk ChildFKInfo) sqlparser.ReferenceAction

func FindUnknownParams added in v0.18.0 

func FindUnknownParams(params map[string]string, knownParams []string) []string

FindUnknownParams a sorted slice of keys in params that are not present in knownParams.

func LoadFormal 

func LoadFormal(filename string) (*vschemapb.SrvVSchema, error)

LoadFormal loads the JSON representation of VSchema from a file.

func LoadFormalKeyspace 

func LoadFormalKeyspace(filename string) (*vschemapb.Keyspace, error)

LoadFormalKeyspace loads the JSON representation of VSchema from a file, for a single keyspace.

func Map 

func Map(ctx context.Context, vindex Vindex, vcursor VCursor, rowsColValues [][]sqltypes.Value) ([]key.Destination, error)

Map invokes the Map implementation supplied by the vindex.

func NewKeyRangeFromPrefix added in v0.11.0 

func NewKeyRangeFromPrefix(begin []byte) key.Destination

NewKeyRangeFromPrefix creates a keyspace range from a prefix of keyspace id.

func Register 

func Register(vindexType string, newVindexFunc NewVindexFunc)

Register registers a vindex factory under the specified vindexType. A duplicate vindexType will generate a panic. New vindexes will be created using these functions at the time of vschema loading.

func UpdateAction added in v0.18.0 

func UpdateAction(fk ChildFKInfo) sqlparser.ReferenceAction

func Verify 

func Verify(ctx context.Context, vindex Vindex, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify invokes the Verify implementation supplied by the vindex.

Types

type AutoIncrement 

type AutoIncrement struct {
	Column   sqlparser.IdentifierCI `json:"column"`
	Sequence *Table                 `json:"sequence"`
}

AutoIncrement contains the auto-inc information for a table.

type Binary 

type Binary struct {
	// contains filtered or unexported fields
}

Binary is a vindex that converts binary bits to a keyspace id.

func (*Binary) CachedSize added in v0.10.0 

func (cached *Binary) CachedSize(alloc bool) int64

func (*Binary) Cost 

func (vind *Binary) Cost() int

Cost returns the cost as 1.

func (*Binary) Hash added in v0.13.0 

func (vind *Binary) Hash(id sqltypes.Value) ([]byte, error)

func (*Binary) IsUnique 

func (vind *Binary) IsUnique() bool

IsUnique returns true since the Vindex is unique.

func (*Binary) Map 

func (vind *Binary) Map(ctx context.Context, vcursor VCursor, ids []sqltypes.Value) ([]key.Destination, error)

Map can map ids to key.Destination objects.

func (*Binary) NeedsVCursor 

func (vind *Binary) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*Binary) ReverseMap 

func (*Binary) ReverseMap(_ VCursor, ksids [][]byte) ([]sqltypes.Value, error)

ReverseMap returns the associated ids for the ksids.

func (*Binary) String 

func (vind *Binary) String() string

String returns the name of the vindex.

func (*Binary) UnknownParams added in v0.18.0 

func (vind *Binary) UnknownParams() []string

UnknownParams implements the ParamValidating interface.

func (*Binary) Verify 

func (vind *Binary) Verify(ctx context.Context, vcursor VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify returns true if ids maps to ksids.

type BinaryMD5 

type BinaryMD5 struct {
	// contains filtered or unexported fields
}

BinaryMD5 is a vindex that hashes binary bits to a keyspace id.

func (*BinaryMD5) CachedSize added in v0.10.0 

func (cached *BinaryMD5) CachedSize(alloc bool) int64

func (*BinaryMD5) Cost 

func (vind *BinaryMD5) Cost() int

Cost returns the cost as 1.

func (*BinaryMD5) Hash added in v0.13.0 

func (vind *BinaryMD5) Hash(id sqltypes.Value) ([]byte, error)

func (*BinaryMD5) IsUnique 

func (vind *BinaryMD5) IsUnique() bool

IsUnique returns true since the Vindex is unique.

func (*BinaryMD5) Map 

func (vind *BinaryMD5) Map(ctx context.Context, vcursor VCursor, ids []sqltypes.Value) ([]key.Destination, error)

Map can map ids to key.Destination objects.

func (*BinaryMD5) NeedsVCursor 

func (vind *BinaryMD5) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*BinaryMD5) String 

func (vind *BinaryMD5) String() string

String returns the name of the vindex.

func (*BinaryMD5) UnknownParams added in v0.18.0 

func (vind *BinaryMD5) UnknownParams() []string

UnknownParams implements the ParamValidating interface.

func (*BinaryMD5) Verify 

func (vind *BinaryMD5) Verify(ctx context.Context, vcursor VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify returns true if ids maps to ksids.

type ByCost 

type ByCost []*ColumnVindex

ByCost provides the interface needed for ColumnVindexes to be sorted by cost order.

func (ByCost) Len 

func (bc ByCost) Len() int

func (ByCost) Less 

func (bc ByCost) Less(i, j int) bool

func (ByCost) Swap 

func (bc ByCost) Swap(i, j int)

type CFC added in v0.11.0 

type CFC struct {
	// contains filtered or unexported fields
}

CFC is Concatenated Fixed-width Composite Vindex.

The purpose of this vindex is to shard the rows based on the prefix of sharding key. Imagine the sharding key is defined as (s1, s2, ... sN), a prefix of this key is (s1, s2, ... sj) (j <= N). This vindex puts the rows with the same prefix among a same group of shards instead of scatter them around all the shards. The benefit of doing so is that prefix queries will only fanout to a subset of shards instead of all the shards. Specifically this vindex maps the full key, i.e. (s1, s2, ... sN) to a `key.DestinationKeyspaceID` and the prefix of it, i.e. (s1, s2, ... sj)(j<N) to a `key.DestinationKeyRange`. Note that the prefix to key range mapping is only active in 'LIKE' expression. When a column with CFC defined appears in other expressions, e.g. =, !=, IN etc, it behaves exactly as other functional unique vindexes.

This provides the capability to model hierarchical data models. If we consider the prefix as the 'parent' key and the full key as the 'child' key, all the child data is clustered within the same group of shards identified by the 'parent' key.

Due to the prevalance of using `vindexes.SingleColumn` in vindexes, it's way more complex to implement a true multi-column composite index (see github issue) than to implement it using a single column vindex where the components of the composite keys are concatenated together to form a single key. The user can use this single key directly as the keyspace id; one can also define a hash function so that the keyspace id is the concatenation of hash(s1), hash(s2), ... hash(sN). Using the concatenated key directly makes it easier to reason the fanout but the data distribution depends on the key itself; while using the hash on components takes care of the randomness of the data distribution.

Since the vindex is on a concatenated key, the offsets into the key are the only way to mark its components. Thus it implicitly requires each component to have a fixed width, except the last one. It's especially true when hash is defined. Because the hash is calculated component by component, only the prefix that aligns with the component boundary can be used to compute the key range. Although the misaligned part doesn't participate the key range calculation, the SQL executed on each shard uses the unchanged prefix; thus the behavior is exactly same as other vindex's but just more efficient in controlling the fanout.

The expected format of the vindex definition is 

"vindexes": {
  "cfc_md5": {
    "type": "cfc",
    "params": {
      "hash": "md5",
      "offsets": "[2,4]"
    }
  }
}

'offsets' only makes sense when hash is used. Offsets should be a sorted list of positive ints, each of which denotes the byte offset (from the beginning of key) of each component's boundary in the concatenated key. Specifically, offsets[0] is the byte offset of the first component, offsets[1] is the byte offset of the second component, etc.

func (*CFC) CachedSize added in v0.11.0 

func (cached *CFC) CachedSize(alloc bool) int64

func (*CFC) Cost added in v0.11.0 

func (vind *CFC) Cost() int

Cost returns the cost as 1. In regular mode, i.e. not in a LIKE op, CFC has pretty much the same cost as other unique vindexes like 'binary', 'md5' etc.

func (*CFC) IsUnique added in v0.11.0 

func (vind *CFC) IsUnique() bool

IsUnique returns true since the Vindex is unique.

func (*CFC) Map added in v0.11.0 

func (vind *CFC) Map(_ context.Context, _ VCursor, ids []sqltypes.Value) ([]key.Destination, error)

Map can map ids to key.Destination objects.

func (*CFC) NeedsVCursor added in v0.11.0 

func (vind *CFC) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*CFC) PrefixVindex added in v0.11.0 

func (vind *CFC) PrefixVindex() SingleColumn

PrefixVindex switches the vindex to prefix mode

func (*CFC) String added in v0.11.0 

func (vind *CFC) String() string

func (CFC) UnknownParams added in v0.18.0 

func (vind CFC) UnknownParams() []string

UnknownParams implements the ParamValidating interface.

func (*CFC) Verify added in v0.11.0 

func (vind *CFC) Verify(_ context.Context, _ VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify returns true if ids maps to ksids.

type ChildFKInfo added in v0.18.0 

type ChildFKInfo struct {
	Table         *Table
	ChildColumns  sqlparser.Columns
	ParentColumns sqlparser.Columns
	Match         sqlparser.MatchAction
	OnDelete      sqlparser.ReferenceAction
	OnUpdate      sqlparser.ReferenceAction
}

ChildFKInfo contains the child foreign key info for the table.

func NewChildFkInfo added in v0.18.0 

func NewChildFkInfo(childTbl *Table, fkDef *sqlparser.ForeignKeyDefinition) ChildFKInfo

NewChildFkInfo creates a new ChildFKInfo.

func (*ChildFKInfo) MarshalJSON added in v0.18.0 

func (fk *ChildFKInfo) MarshalJSON() ([]byte, error)

MarshalJSON returns a JSON representation of ChildFKInfo.

func (*ChildFKInfo) String added in v0.18.0 

func (fk *ChildFKInfo) String(parentTable *Table) string

type Column 

type Column struct {
	Name          sqlparser.IdentifierCI `json:"name"`
	Type          querypb.Type           `json:"type"`
	CollationName string                 `json:"collation_name"`
	Default       sqlparser.Expr         `json:"default,omitempty"`

	// Invisible marks this as a column that will not be automatically included in `*` projections
	Invisible bool  `json:"invisible,omitempty"`
	Size      int32 `json:"size,omitempty"`
	Scale     int32 `json:"scale,omitempty"`
	Nullable  bool  `json:"nullable,omitempty"`
	// Values contains the list of values for enum and set types.
	Values []string `json:"values,omitempty"`
}

Column describes a column.

func (*Column) MarshalJSON 

func (col *Column) MarshalJSON() ([]byte, error)

MarshalJSON returns a JSON representation of Column.

func (*Column) ToEvalengineType added in v0.19.0 

func (col *Column) ToEvalengineType(collationEnv *collations.Environment) evalengine.Type

type ColumnVindex 

type ColumnVindex struct {
	Columns []sqlparser.IdentifierCI `json:"columns"`
	Type    string                   `json:"type"`
	Name    string                   `json:"name"`
	Owned   bool                     `json:"owned,omitempty"`
	Vindex  Vindex                   `json:"vindex"`
	// contains filtered or unexported fields
}

ColumnVindex contains the index info for each index of a table.

func FindBestColVindex 

func FindBestColVindex(table *Table) (*ColumnVindex, error)

FindBestColVindex finds the best ColumnVindex for VReplication.

func FindVindexForSharding 

func FindVindexForSharding(tableName string, colVindexes []*ColumnVindex) (*ColumnVindex, error)

FindVindexForSharding searches through the given slice to find the lowest cost unique vindex primary vindex is always unique if two have the same cost, use the one that occurs earlier in the definition if the final result is too expensive, return nil

func (*ColumnVindex) CachedSize added in v0.10.0 

func (cached *ColumnVindex) CachedSize(alloc bool) int64

func (*ColumnVindex) Cost added in v0.13.0 

func (c *ColumnVindex) Cost() int

Cost represents the cost associated with using the ColumnVindex

func (*ColumnVindex) IsBackfilling added in v0.16.3 

func (c *ColumnVindex) IsBackfilling() bool

IsBackfilling returns true if the vindex is in the process of backfilling the rows.

func (*ColumnVindex) IsPartialVindex added in v0.14.0 

func (c *ColumnVindex) IsPartialVindex() bool

IsPartialVindex is used to let planner and engine know that this is a composite vindex missing one or more columns

func (*ColumnVindex) IsUnique added in v0.13.0 

func (c *ColumnVindex) IsUnique() bool

IsUnique is used to tell whether the ColumnVindex will return a unique shard value or not when queried with the given column list

type ConsistentLookup 

type ConsistentLookup struct {
	// contains filtered or unexported fields
}

ConsistentLookup is a non-unique lookup vindex that can stay consistent with respect to its owner table.

func (*ConsistentLookup) AllowBatch added in v0.15.0 

func (lu *ConsistentLookup) AllowBatch() bool

AllowBatch implements the LookupPlanable interface

func (*ConsistentLookup) AutoCommitEnabled added in v0.15.3 

func (lu *ConsistentLookup) AutoCommitEnabled() bool

func (*ConsistentLookup) CachedSize added in v0.10.0 

func (cached *ConsistentLookup) CachedSize(alloc bool) int64

func (*ConsistentLookup) Cost 

func (lu *ConsistentLookup) Cost() int

Cost returns the cost of this vindex as 20.

func (ConsistentLookup) Create 

func (lu ConsistentLookup) Create(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksids [][]byte, ignoreMode bool) error

Create reserves the id by inserting it into the vindex table.

func (ConsistentLookup) Delete 

func (lu ConsistentLookup) Delete(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksid []byte) error

Delete deletes the entry from the vindex table.

func (ConsistentLookup) GetCommitOrder added in v0.15.0 

func (lu ConsistentLookup) GetCommitOrder() vtgatepb.CommitOrder

GetCommitOrder implements the LookupPlanable interface

func (ConsistentLookup) IsBackfilling added in v0.19.0 

func (lu ConsistentLookup) IsBackfilling() bool

IsBackfilling implements the LookupBackfill interface

func (*ConsistentLookup) IsUnique 

func (lu *ConsistentLookup) IsUnique() bool

IsUnique returns false since the Vindex is non unique.

func (*ConsistentLookup) Map 

func (lu *ConsistentLookup) Map(ctx context.Context, vcursor VCursor, ids []sqltypes.Value) ([]key.Destination, error)

Map can map ids to key.Destination objects.

func (*ConsistentLookup) MapResult added in v0.15.0 

func (lu *ConsistentLookup) MapResult(ids []sqltypes.Value, results []*sqltypes.Result) ([]key.Destination, error)

MapResult implements the LookupPlanable interface

func (ConsistentLookup) MarshalJSON 

func (lu ConsistentLookup) MarshalJSON() ([]byte, error)

MarshalJSON returns a JSON representation of clCommon.

func (*ConsistentLookup) NeedsVCursor 

func (lu *ConsistentLookup) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*ConsistentLookup) Query added in v0.15.0 

func (lu *ConsistentLookup) Query() (selQuery string, arguments []string)

Query implements the LookupPlanable interface

func (ConsistentLookup) SetOwnerInfo 

func (lu ConsistentLookup) SetOwnerInfo(keyspace, table string, cols []sqlparser.IdentifierCI) error

func (ConsistentLookup) String 

func (lu ConsistentLookup) String() string

String returns the name of the vindex.

func (*ConsistentLookup) UnknownParams added in v0.18.0 

func (lu *ConsistentLookup) UnknownParams() []string

UnknownParams implements the ParamValidating interface.

func (ConsistentLookup) Update 

func (lu ConsistentLookup) Update(ctx context.Context, vcursor VCursor, oldValues []sqltypes.Value, ksid []byte, newValues []sqltypes.Value) error

Update updates the entry in the vindex table.

func (ConsistentLookup) Verify 

func (lu ConsistentLookup) Verify(ctx context.Context, vcursor VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify returns true if ids maps to ksids.

type ConsistentLookupUnique 

type ConsistentLookupUnique struct {
	// contains filtered or unexported fields
}

ConsistentLookupUnique defines a vindex that uses a lookup table. The table is expected to define the id column as unique. It's Unique and a Lookup.

func (*ConsistentLookupUnique) AllowBatch added in v0.15.0 

func (lu *ConsistentLookupUnique) AllowBatch() bool

AllowBatch implements the LookupPlanable interface

func (*ConsistentLookupUnique) AutoCommitEnabled added in v0.15.3 

func (lu *ConsistentLookupUnique) AutoCommitEnabled() bool

func (*ConsistentLookupUnique) CachedSize added in v0.10.0 

func (cached *ConsistentLookupUnique) CachedSize(alloc bool) int64

func (*ConsistentLookupUnique) Cost 

func (lu *ConsistentLookupUnique) Cost() int

Cost returns the cost of this vindex as 10.

func (ConsistentLookupUnique) Create 

func (lu ConsistentLookupUnique) Create(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksids [][]byte, ignoreMode bool) error

Create reserves the id by inserting it into the vindex table.

func (ConsistentLookupUnique) Delete 

func (lu ConsistentLookupUnique) Delete(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksid []byte) error

Delete deletes the entry from the vindex table.

func (ConsistentLookupUnique) GetCommitOrder added in v0.15.0 

func (lu ConsistentLookupUnique) GetCommitOrder() vtgatepb.CommitOrder

GetCommitOrder implements the LookupPlanable interface

func (ConsistentLookupUnique) IsBackfilling added in v0.12.0 

func (lu ConsistentLookupUnique) IsBackfilling() bool

IsBackfilling implements the LookupBackfill interface

func (*ConsistentLookupUnique) IsUnique 

func (lu *ConsistentLookupUnique) IsUnique() bool

IsUnique returns true since the Vindex is unique.

func (*ConsistentLookupUnique) Map 

func (lu *ConsistentLookupUnique) Map(ctx context.Context, vcursor VCursor, ids []sqltypes.Value) ([]key.Destination, error)

Map can map ids to key.Destination objects.

func (*ConsistentLookupUnique) MapResult added in v0.15.0 

func (lu *ConsistentLookupUnique) MapResult(ids []sqltypes.Value, results []*sqltypes.Result) ([]key.Destination, error)

MapResult implements the LookupPlanable interface

func (ConsistentLookupUnique) MarshalJSON 

func (lu ConsistentLookupUnique) MarshalJSON() ([]byte, error)

MarshalJSON returns a JSON representation of clCommon.

func (*ConsistentLookupUnique) NeedsVCursor 

func (lu *ConsistentLookupUnique) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*ConsistentLookupUnique) Query added in v0.15.0 

func (lu *ConsistentLookupUnique) Query() (selQuery string, arguments []string)

Query implements the LookupPlanable interface

func (ConsistentLookupUnique) SetOwnerInfo 

func (lu ConsistentLookupUnique) SetOwnerInfo(keyspace, table string, cols []sqlparser.IdentifierCI) error

func (ConsistentLookupUnique) String 

func (lu ConsistentLookupUnique) String() string

String returns the name of the vindex.

func (*ConsistentLookupUnique) UnknownParams added in v0.18.0 

func (lu *ConsistentLookupUnique) UnknownParams() []string

UnknownParams implements the ParamValidating interface.

func (ConsistentLookupUnique) Update 

func (lu ConsistentLookupUnique) Update(ctx context.Context, vcursor VCursor, oldValues []sqltypes.Value, ksid []byte, newValues []sqltypes.Value) error

Update updates the entry in the vindex table.

func (ConsistentLookupUnique) Verify 

func (lu ConsistentLookupUnique) Verify(ctx context.Context, vcursor VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify returns true if ids maps to ksids.

type Hash 

type Hash struct {
	// contains filtered or unexported fields
}

Hash defines vindex that hashes an int64 to a KeyspaceId by using null-key DES hash. It's Unique, Reversible and Functional. Note that at once stage we used a 3DES-based hash here, but for a null key as in our case, they are completely equivalent.

func (*Hash) CachedSize added in v0.10.0 

func (cached *Hash) CachedSize(alloc bool) int64

func (*Hash) Cost 

func (vind *Hash) Cost() int

Cost returns the cost of this index as 1.

func (*Hash) Hash added in v0.13.0 

func (vind *Hash) Hash(id sqltypes.Value) ([]byte, error)

func (*Hash) IsUnique 

func (vind *Hash) IsUnique() bool

IsUnique returns true since the Vindex is unique.

func (*Hash) Map 

func (vind *Hash) Map(ctx context.Context, vcursor VCursor, ids []sqltypes.Value) ([]key.Destination, error)

Map can map ids to key.Destination objects.

func (*Hash) NeedsVCursor 

func (vind *Hash) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*Hash) ReverseMap 

func (vind *Hash) ReverseMap(_ VCursor, ksids [][]byte) ([]sqltypes.Value, error)

ReverseMap returns the ids from ksids.

func (*Hash) String 

func (vind *Hash) String() string

String returns the name of the vindex.

func (*Hash) UnknownParams added in v0.18.0 

func (vind *Hash) UnknownParams() []string

UnknownParams implements the ParamValidating interface.

func (*Hash) Verify 

func (vind *Hash) Verify(ctx context.Context, vcursor VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify returns true if ids maps to ksids.

type Hashing added in v0.13.0 

type Hashing interface {
	Hash(id sqltypes.Value) ([]byte, error)
}

Hashing defined the interface for the vindexes that export the Hash function to be used by multi-column vindex.

type Keyspace 

type Keyspace struct {
	Name    string
	Sharded bool
}

Keyspace contains the keyspcae info for each Table.

func (*Keyspace) CachedSize added in v0.10.0 

func (cached *Keyspace) CachedSize(alloc bool) int64

type KeyspaceSchema 

type KeyspaceSchema struct {
	Keyspace        *Keyspace
	ForeignKeyMode  vschemapb.Keyspace_ForeignKeyMode
	Tables          map[string]*Table
	Vindexes        map[string]Vindex
	Views           map[string]sqlparser.SelectStatement
	Error           error
	MultiTenantSpec *vschemapb.MultiTenantSpec

	// These are the UDFs that exist in the schema and are aggregations
	AggregateUDFs []string
}

KeyspaceSchema contains the schema(table) for a keyspace.

func BuildKeyspace added in v0.18.0 

func BuildKeyspace(input *vschemapb.Keyspace, parser *sqlparser.Parser) (*KeyspaceSchema, error)

BuildKeyspace ensures that the keyspace vschema is valid. External references (like sequence) are not validated.

func BuildKeyspaceSchema 

func BuildKeyspaceSchema(input *vschemapb.Keyspace, keyspace string, parser *sqlparser.Parser) (*KeyspaceSchema, error)

BuildKeyspaceSchema builds the vschema portion for one keyspace. The build ignores sequence references because those dependencies can go cross-keyspace.

func (*KeyspaceSchema) MarshalJSON 

func (ks *KeyspaceSchema) MarshalJSON() ([]byte, error)

MarshalJSON returns a JSON representation of KeyspaceSchema.

type Lookup 

type Lookup interface {
	// Create creates an association between ids and ksids. If ignoreMode
	// is true, then the Create should ignore dup key errors.
	Create(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksids [][]byte, ignoreMode bool) error

	Delete(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksid []byte) error

	// Update replaces the mapping of old values with new values for a keyspace id.
	Update(ctx context.Context, vcursor VCursor, oldValues []sqltypes.Value, ksid []byte, newValues []sqltypes.Value) error
}

A Lookup vindex is one that needs to lookup a previously stored map to compute the keyspace id from an id. This means that the creation of a lookup vindex entry requires a keyspace id as input. A Lookup vindex need not be unique because the keyspace_id, which must be supplied, can be used to determine the target shard for an insert operation.

type LookupBackfill added in v0.12.0 

type LookupBackfill interface {
	IsBackfilling() bool
}

LookupBackfill interfaces all lookup vindexes that can backfill rows, such as LookupUnique.

type LookupHash 

type LookupHash struct {
	// contains filtered or unexported fields
}

LookupHash defines a vindex that uses a lookup table. The table is expected to define the id column as unique. It's NonUnique and a Lookup. Warning: This Vindex is being deprecated in favor of Lookup

func (*LookupHash) AllowBatch added in v0.15.0 

func (lh *LookupHash) AllowBatch() bool

AllowBatch implements the LookupPlanable interface

func (*LookupHash) AutoCommitEnabled added in v0.15.3 

func (lh *LookupHash) AutoCommitEnabled() bool

func (*LookupHash) CachedSize added in v0.10.0 

func (cached *LookupHash) CachedSize(alloc bool) int64

func (*LookupHash) Cost 

func (lh *LookupHash) Cost() int

Cost returns the cost of this vindex as 20.

func (*LookupHash) Create 

func (lh *LookupHash) Create(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksids [][]byte, ignoreMode bool) error

Create reserves the id by inserting it into the vindex table.

func (*LookupHash) Delete 

func (lh *LookupHash) Delete(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksid []byte) error

Delete deletes the entry from the vindex table.

func (*LookupHash) GetCommitOrder added in v0.15.0 

func (lh *LookupHash) GetCommitOrder() vtgatepb.CommitOrder

GetCommitOrder implements the LookupPlanable interface

func (*LookupHash) IsUnique 

func (lh *LookupHash) IsUnique() bool

IsUnique returns false since the Vindex is not unique.

func (*LookupHash) Map 

func (lh *LookupHash) Map(ctx context.Context, vcursor VCursor, ids []sqltypes.Value) ([]key.Destination, error)

Map can map ids to key.Destination objects.

func (*LookupHash) MapResult added in v0.15.0 

func (lh *LookupHash) MapResult(ids []sqltypes.Value, results []*sqltypes.Result) ([]key.Destination, error)

MapResult implements the LookupPlanable interface

func (*LookupHash) MarshalJSON 

func (lh *LookupHash) MarshalJSON() ([]byte, error)

MarshalJSON returns a JSON representation of LookupHash.

func (*LookupHash) NeedsVCursor 

func (lh *LookupHash) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*LookupHash) Query added in v0.15.0 

func (lh *LookupHash) Query() (selQuery string, arguments []string)

Query implements the LookupPlanable interface

func (*LookupHash) String 

func (lh *LookupHash) String() string

String returns the name of the vindex.

func (*LookupHash) UnknownParams added in v0.18.0 

func (lh *LookupHash) UnknownParams() []string

UnknownParams satisfies the ParamValidating interface.

func (*LookupHash) Update 

func (lh *LookupHash) Update(ctx context.Context, vcursor VCursor, oldValues []sqltypes.Value, ksid []byte, newValues []sqltypes.Value) error

Update updates the entry in the vindex table.

func (*LookupHash) Verify 

func (lh *LookupHash) Verify(ctx context.Context, vcursor VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify returns true if ids maps to ksids.

type LookupHashUnique 

type LookupHashUnique struct {
	// contains filtered or unexported fields
}

LookupHashUnique defines a vindex that uses a lookup table. The table is expected to define the id column as unique. It's Unique and a Lookup. Warning: This Vindex is being deprecated in favor of LookupUnique

func (*LookupHashUnique) AllowBatch added in v0.15.0 

func (lhu *LookupHashUnique) AllowBatch() bool

func (*LookupHashUnique) AutoCommitEnabled added in v0.15.3 

func (lhu *LookupHashUnique) AutoCommitEnabled() bool

func (*LookupHashUnique) CachedSize added in v0.10.0 

func (cached *LookupHashUnique) CachedSize(alloc bool) int64

func (*LookupHashUnique) Cost 

func (lhu *LookupHashUnique) Cost() int

Cost returns the cost of this vindex as 10.

func (*LookupHashUnique) Create 

func (lhu *LookupHashUnique) Create(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksids [][]byte, ignoreMode bool) error

Create reserves the id by inserting it into the vindex table.

func (*LookupHashUnique) Delete 

func (lhu *LookupHashUnique) Delete(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksid []byte) error

Delete deletes the entry from the vindex table.

func (*LookupHashUnique) GetCommitOrder added in v0.15.0 

func (lhu *LookupHashUnique) GetCommitOrder() vtgatepb.CommitOrder

GetCommitOrder implements the LookupPlanable interface

func (*LookupHashUnique) IsBackfilling added in v0.12.0 

func (lhu *LookupHashUnique) IsBackfilling() bool

IsBackfilling implements the LookupBackfill interface

func (*LookupHashUnique) IsUnique 

func (lhu *LookupHashUnique) IsUnique() bool

IsUnique returns true since the Vindex is unique.

func (*LookupHashUnique) Map 

func (lhu *LookupHashUnique) Map(ctx context.Context, vcursor VCursor, ids []sqltypes.Value) ([]key.Destination, error)

Map can map ids to key.Destination objects.

func (*LookupHashUnique) MapResult added in v0.15.0 

func (lhu *LookupHashUnique) MapResult(ids []sqltypes.Value, results []*sqltypes.Result) ([]key.Destination, error)

func (*LookupHashUnique) MarshalJSON 

func (lhu *LookupHashUnique) MarshalJSON() ([]byte, error)

MarshalJSON returns a JSON representation of LookupHashUnique.

func (*LookupHashUnique) NeedsVCursor 

func (lhu *LookupHashUnique) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*LookupHashUnique) Query added in v0.15.0 

func (lhu *LookupHashUnique) Query() (selQuery string, arguments []string)

func (*LookupHashUnique) String 

func (lhu *LookupHashUnique) String() string

String returns the name of the vindex.

func (*LookupHashUnique) UnknownParams added in v0.18.0 

func (lhu *LookupHashUnique) UnknownParams() []string

UnknownParams implements the ParamValidating interface.

func (*LookupHashUnique) Update 

func (lhu *LookupHashUnique) Update(ctx context.Context, vcursor VCursor, oldValues []sqltypes.Value, ksid []byte, newValues []sqltypes.Value) error

Update updates the entry in the vindex table.

func (*LookupHashUnique) Verify 

func (lhu *LookupHashUnique) Verify(ctx context.Context, vcursor VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify returns true if ids maps to ksids.

type LookupNonUnique 

type LookupNonUnique struct {
	// contains filtered or unexported fields
}

LookupNonUnique defines a vindex that uses a lookup table and create a mapping between from ids and KeyspaceId. It's NonUnique and a Lookup.

func (*LookupNonUnique) AllowBatch added in v0.15.0 

func (ln *LookupNonUnique) AllowBatch() bool

func (*LookupNonUnique) AutoCommitEnabled added in v0.15.3 

func (ln *LookupNonUnique) AutoCommitEnabled() bool

func (*LookupNonUnique) CachedSize added in v0.10.0 

func (cached *LookupNonUnique) CachedSize(alloc bool) int64

func (*LookupNonUnique) Cost 

func (ln *LookupNonUnique) Cost() int

Cost returns the cost of this vindex as 20.

func (*LookupNonUnique) Create 

func (ln *LookupNonUnique) Create(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksids [][]byte, ignoreMode bool) error

Create reserves the id by inserting it into the vindex table.

func (*LookupNonUnique) Delete 

func (ln *LookupNonUnique) Delete(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksid []byte) error

Delete deletes the entry from the vindex table.

func (*LookupNonUnique) GetCommitOrder added in v0.15.0 

func (ln *LookupNonUnique) GetCommitOrder() vtgatepb.CommitOrder

func (*LookupNonUnique) IsBackfilling added in v0.19.0 

func (ln *LookupNonUnique) IsBackfilling() bool

IsBackfilling implements the LookupBackfill interface

func (*LookupNonUnique) IsUnique 

func (ln *LookupNonUnique) IsUnique() bool

IsUnique returns false since the Vindex is non unique.

func (*LookupNonUnique) Map 

func (ln *LookupNonUnique) Map(ctx context.Context, vcursor VCursor, ids []sqltypes.Value) ([]key.Destination, error)

Map can map ids to key.Destination objects.

func (*LookupNonUnique) MapResult added in v0.15.0 

func (ln *LookupNonUnique) MapResult(ids []sqltypes.Value, results []*sqltypes.Result) ([]key.Destination, error)

MapResult implements the LookupPlanable interface

func (*LookupNonUnique) MarshalJSON 

func (ln *LookupNonUnique) MarshalJSON() ([]byte, error)

MarshalJSON returns a JSON representation of LookupHash.

func (*LookupNonUnique) NeedsVCursor 

func (ln *LookupNonUnique) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*LookupNonUnique) Query added in v0.15.0 

func (ln *LookupNonUnique) Query() (selQuery string, arguments []string)

Query implements the LookupPlanable interface

func (*LookupNonUnique) String 

func (ln *LookupNonUnique) String() string

String returns the name of the vindex.

func (*LookupNonUnique) UnknownParams added in v0.18.0 

func (ln *LookupNonUnique) UnknownParams() []string

UnknownParams implements the ParamValidating interface.

func (*LookupNonUnique) Update 

func (ln *LookupNonUnique) Update(ctx context.Context, vcursor VCursor, oldValues []sqltypes.Value, ksid []byte, newValues []sqltypes.Value) error

Update updates the entry in the vindex table.

func (*LookupNonUnique) Verify 

func (ln *LookupNonUnique) Verify(ctx context.Context, vcursor VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify returns true if ids maps to ksids.

type LookupPlanable added in v0.15.0 

type LookupPlanable interface {
	String() string
	Query() (selQuery string, arguments []string)
	MapResult(ids []sqltypes.Value, results []*sqltypes.Result) ([]key.Destination, error)
	AllowBatch() bool
	GetCommitOrder() vtgatepb.CommitOrder
	AutoCommitEnabled() bool
}

LookupPlanable are for lookup vindexes where we can extract the lookup query at plan time

type LookupUnicodeLooseMD5Hash 

type LookupUnicodeLooseMD5Hash struct {
	// contains filtered or unexported fields
}

LookupUnicodeLooseMD5Hash defines a vindex that uses a lookup table. The table is expected to define the id column as unique. It's NonUnique and a Lookup and stores the from value in a hashed form. Warning: This Vindex is being deprecated in favor of Lookup

func (*LookupUnicodeLooseMD5Hash) AutoCommitEnabled added in v0.15.3 

func (lh *LookupUnicodeLooseMD5Hash) AutoCommitEnabled() bool

func (*LookupUnicodeLooseMD5Hash) CachedSize added in v0.10.0 

func (cached *LookupUnicodeLooseMD5Hash) CachedSize(alloc bool) int64

func (*LookupUnicodeLooseMD5Hash) Cost 

func (lh *LookupUnicodeLooseMD5Hash) Cost() int

Cost returns the cost of this vindex as 20.

func (*LookupUnicodeLooseMD5Hash) Create 

func (lh *LookupUnicodeLooseMD5Hash) Create(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksids [][]byte, ignoreMode bool) error

Create reserves the id by inserting it into the vindex table.

func (*LookupUnicodeLooseMD5Hash) Delete 

func (lh *LookupUnicodeLooseMD5Hash) Delete(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksid []byte) error

Delete deletes the entry from the vindex table.

func (*LookupUnicodeLooseMD5Hash) IsUnique 

func (lh *LookupUnicodeLooseMD5Hash) IsUnique() bool

IsUnique returns false since the Vindex is not unique.

func (*LookupUnicodeLooseMD5Hash) Map 

func (lh *LookupUnicodeLooseMD5Hash) Map(ctx context.Context, vcursor VCursor, ids []sqltypes.Value) ([]key.Destination, error)

Map can map ids to key.Destination objects.

func (*LookupUnicodeLooseMD5Hash) MarshalJSON 

func (lh *LookupUnicodeLooseMD5Hash) MarshalJSON() ([]byte, error)

MarshalJSON returns a JSON representation of LookupHash.

func (*LookupUnicodeLooseMD5Hash) NeedsVCursor 

func (lh *LookupUnicodeLooseMD5Hash) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*LookupUnicodeLooseMD5Hash) String 

func (lh *LookupUnicodeLooseMD5Hash) String() string

String returns the name of the vindex.

func (*LookupUnicodeLooseMD5Hash) UnknownParams added in v0.18.0 

func (lh *LookupUnicodeLooseMD5Hash) UnknownParams() []string

UnknownParams implements the ParamValidating interface.

func (*LookupUnicodeLooseMD5Hash) Update 

func (lh *LookupUnicodeLooseMD5Hash) Update(ctx context.Context, vcursor VCursor, oldValues []sqltypes.Value, ksid []byte, newValues []sqltypes.Value) error

Update updates the entry in the vindex table.

func (*LookupUnicodeLooseMD5Hash) Verify 

func (lh *LookupUnicodeLooseMD5Hash) Verify(ctx context.Context, vcursor VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify returns true if ids maps to ksids.

type LookupUnicodeLooseMD5HashUnique 

type LookupUnicodeLooseMD5HashUnique struct {
	// contains filtered or unexported fields
}

LookupUnicodeLooseMD5HashUnique defines a vindex that uses a lookup table. The table is expected to define the id column as unique. It's Unique and a Lookup and will store the from value in a hashed format. Warning: This Vindex is being deprecated in favor of LookupUnique

func (*LookupUnicodeLooseMD5HashUnique) AutoCommitEnabled added in v0.15.3 

func (lhu *LookupUnicodeLooseMD5HashUnique) AutoCommitEnabled() bool

func (*LookupUnicodeLooseMD5HashUnique) CachedSize added in v0.10.0 

func (cached *LookupUnicodeLooseMD5HashUnique) CachedSize(alloc bool) int64

func (*LookupUnicodeLooseMD5HashUnique) Cost 

func (lhu *LookupUnicodeLooseMD5HashUnique) Cost() int

Cost returns the cost of this vindex as 10.

func (*LookupUnicodeLooseMD5HashUnique) Create 

func (lhu *LookupUnicodeLooseMD5HashUnique) Create(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksids [][]byte, ignoreMode bool) error

Create reserves the id by inserting it into the vindex table.

func (*LookupUnicodeLooseMD5HashUnique) Delete 

func (lhu *LookupUnicodeLooseMD5HashUnique) Delete(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksid []byte) error

Delete deletes the entry from the vindex table.

func (*LookupUnicodeLooseMD5HashUnique) IsBackfilling added in v0.12.0 

func (lhu *LookupUnicodeLooseMD5HashUnique) IsBackfilling() bool

IsBackfilling implements the LookupBackfill interface

func (*LookupUnicodeLooseMD5HashUnique) IsUnique 

func (lhu *LookupUnicodeLooseMD5HashUnique) IsUnique() bool

IsUnique returns true since the Vindex is unique.

func (*LookupUnicodeLooseMD5HashUnique) Map 

func (lhu *LookupUnicodeLooseMD5HashUnique) Map(ctx context.Context, vcursor VCursor, ids []sqltypes.Value) ([]key.Destination, error)

Map can map ids to key.Destination objects.

func (*LookupUnicodeLooseMD5HashUnique) MarshalJSON 

func (lhu *LookupUnicodeLooseMD5HashUnique) MarshalJSON() ([]byte, error)

MarshalJSON returns a JSON representation of LookupHashUnique.

func (*LookupUnicodeLooseMD5HashUnique) NeedsVCursor 

func (lhu *LookupUnicodeLooseMD5HashUnique) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*LookupUnicodeLooseMD5HashUnique) String 

func (lhu *LookupUnicodeLooseMD5HashUnique) String() string

String returns the name of the vindex.

func (*LookupUnicodeLooseMD5HashUnique) UnknownParams added in v0.18.0 

func (lhu *LookupUnicodeLooseMD5HashUnique) UnknownParams() []string

UnknownParams implements the ParamValidating interface.

func (*LookupUnicodeLooseMD5HashUnique) Update 

func (lhu *LookupUnicodeLooseMD5HashUnique) Update(ctx context.Context, vcursor VCursor, oldValues []sqltypes.Value, ksid []byte, newValues []sqltypes.Value) error

Update updates the entry in the vindex table.

func (*LookupUnicodeLooseMD5HashUnique) Verify 

func (lhu *LookupUnicodeLooseMD5HashUnique) Verify(ctx context.Context, vcursor VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify returns true if ids maps to ksids.

type LookupUnique 

type LookupUnique struct {
	// contains filtered or unexported fields
}

LookupUnique defines a vindex that uses a lookup table. The table is expected to define the id column as unique. It's Unique and a Lookup.

func (*LookupUnique) AllowBatch added in v0.15.0 

func (lu *LookupUnique) AllowBatch() bool

func (*LookupUnique) AutoCommitEnabled added in v0.15.3 

func (lu *LookupUnique) AutoCommitEnabled() bool

func (*LookupUnique) CachedSize added in v0.10.0 

func (cached *LookupUnique) CachedSize(alloc bool) int64

func (*LookupUnique) Cost 

func (lu *LookupUnique) Cost() int

Cost returns the cost of this vindex as 10.

func (*LookupUnique) Create 

func (lu *LookupUnique) Create(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksids [][]byte, ignoreMode bool) error

Create reserves the id by inserting it into the vindex table.

func (*LookupUnique) Delete 

func (lu *LookupUnique) Delete(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksid []byte) error

Delete deletes the entry from the vindex table.

func (*LookupUnique) GetCommitOrder added in v0.15.0 

func (lu *LookupUnique) GetCommitOrder() vtgatepb.CommitOrder

func (*LookupUnique) IsBackfilling added in v0.12.0 

func (lu *LookupUnique) IsBackfilling() bool

IsBackfilling implements the LookupBackfill interface

func (*LookupUnique) IsUnique 

func (lu *LookupUnique) IsUnique() bool

IsUnique returns true since the Vindex is unique.

func (*LookupUnique) LookupQuery added in v0.15.0 

func (lu *LookupUnique) LookupQuery() (string, error)

func (*LookupUnique) Map 

func (lu *LookupUnique) Map(ctx context.Context, vcursor VCursor, ids []sqltypes.Value) ([]key.Destination, error)

Map can map ids to key.Destination objects.

func (*LookupUnique) MapResult added in v0.15.0 

func (lu *LookupUnique) MapResult(ids []sqltypes.Value, results []*sqltypes.Result) ([]key.Destination, error)

func (*LookupUnique) MarshalJSON 

func (lu *LookupUnique) MarshalJSON() ([]byte, error)

MarshalJSON returns a JSON representation of LookupUnique.

func (*LookupUnique) NeedsVCursor 

func (lu *LookupUnique) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*LookupUnique) Query added in v0.15.0 

func (lu *LookupUnique) Query() (string, []string)

func (*LookupUnique) String 

func (lu *LookupUnique) String() string

String returns the name of the vindex.

func (*LookupUnique) UnknownParams added in v0.18.0 

func (ln *LookupUnique) UnknownParams() []string

UnknownParams implements the ParamValidating interface.

func (*LookupUnique) Update 

func (lu *LookupUnique) Update(ctx context.Context, vcursor VCursor, oldValues []sqltypes.Value, ksid []byte, newValues []sqltypes.Value) error

Update updates the entry in the vindex table.

func (*LookupUnique) Verify 

func (lu *LookupUnique) Verify(ctx context.Context, vcursor VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify returns true if ids maps to ksids.

type MultiCol added in v0.13.0 

type MultiCol struct {
	// contains filtered or unexported fields
}

func (*MultiCol) CachedSize added in v0.13.0 

func (cached *MultiCol) CachedSize(alloc bool) int64

func (*MultiCol) Cost added in v0.13.0 

func (m *MultiCol) Cost() int

func (*MultiCol) IsUnique added in v0.13.0 

func (m *MultiCol) IsUnique() bool

func (*MultiCol) Map added in v0.13.0 

func (m *MultiCol) Map(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value) ([]key.Destination, error)

func (*MultiCol) NeedsVCursor added in v0.13.0 

func (m *MultiCol) NeedsVCursor() bool

func (*MultiCol) PartialVindex added in v0.13.0 

func (m *MultiCol) PartialVindex() bool

func (*MultiCol) String added in v0.13.0 

func (m *MultiCol) String() string

func (*MultiCol) Verify added in v0.13.0 

func (m *MultiCol) Verify(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksids [][]byte) ([]bool, error)

type MultiColumn 

type MultiColumn interface {
	Vindex
	Map(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value) ([]key.Destination, error)
	Verify(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksids [][]byte) ([]bool, error)
	// PartialVindex returns true if subset of columns can be passed in to the vindex Map and Verify function.
	PartialVindex() bool
}

MultiColumn defines the interface for a multi-column vindex.

type NewVindexFunc 

type NewVindexFunc func(string, map[string]string) (Vindex, error)

A NewVindexFunc is a function that creates a Vindex based on the properties specified in the input map. Every vindex must register a NewVindexFunc under a unique vindexType.

type NotFoundError added in v0.9.0 

type NotFoundError struct {
	TableName string
}

NotFoundError represents the error where the table name was not found

func (NotFoundError) Error added in v0.9.0 

func (n NotFoundError) Error() string

type Null 

type Null struct {
	// contains filtered or unexported fields
}

Null defines a vindex that always return 0. It's Unique and Functional. This is useful for rows that always go into the first shard. This Vindex can be used for validating an unsharded->sharded transition. Unlike other vindexes, this one will work even for NULL input values. This will allow you to keep MySQL auto-inc columns unchanged.

func (*Null) CachedSize added in v0.10.0 

func (cached *Null) CachedSize(alloc bool) int64

func (*Null) Cost 

func (vind *Null) Cost() int

Cost returns the cost of this index as 100.

func (*Null) IsUnique 

func (vind *Null) IsUnique() bool

IsUnique returns true since the Vindex is unique.

func (*Null) Map 

func (vind *Null) Map(ctx context.Context, vcursor VCursor, ids []sqltypes.Value) ([]key.Destination, error)

Map can map ids to key.Destination objects.

func (*Null) NeedsVCursor 

func (vind *Null) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*Null) String 

func (vind *Null) String() string

String returns the name of the vindex.

func (*Null) UnknownParams added in v0.18.0 

func (vind *Null) UnknownParams() []string

UnknownParams implements the ParamValidating interface.

func (*Null) Verify 

func (vind *Null) Verify(ctx context.Context, vcursor VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify returns true if ids maps to ksids.

type Numeric 

type Numeric struct {
	// contains filtered or unexported fields
}

Numeric defines a bit-pattern mapping of a uint64 to the KeyspaceId. It's Unique and Reversible.

func (*Numeric) CachedSize added in v0.10.0 

func (cached *Numeric) CachedSize(alloc bool) int64

func (*Numeric) Cost 

func (*Numeric) Cost() int

Cost returns the cost of this vindex as 0.

func (*Numeric) Hash added in v0.13.0 

func (*Numeric) Hash(id sqltypes.Value) ([]byte, error)

func (*Numeric) IsUnique 

func (*Numeric) IsUnique() bool

IsUnique returns true since the Vindex is unique.

func (*Numeric) Map 

func (vind *Numeric) Map(ctx context.Context, vcursor VCursor, ids []sqltypes.Value) ([]key.Destination, error)

Map can map ids to key.Destination objects.

func (*Numeric) NeedsVCursor 

func (*Numeric) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*Numeric) ReverseMap 

func (*Numeric) ReverseMap(_ VCursor, ksids [][]byte) ([]sqltypes.Value, error)

ReverseMap returns the associated ids for the ksids.

func (*Numeric) String 

func (vind *Numeric) String() string

String returns the name of the vindex.

func (*Numeric) UnknownParams added in v0.18.0 

func (vind *Numeric) UnknownParams() []string

UnknownParams implements the ParamValidating interface.

func (*Numeric) Verify 

func (vind *Numeric) Verify(ctx context.Context, vcursor VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify returns true if ids and ksids match.

type NumericLookupTable 

type NumericLookupTable map[uint64]uint64

NumericLookupTable stores the mapping of keys.

type NumericStaticMap 

type NumericStaticMap struct {
	// contains filtered or unexported fields
}

NumericStaticMap is similar to vindex Numeric but first attempts a lookup via a JSON file.

func (*NumericStaticMap) CachedSize added in v0.10.0 

func (cached *NumericStaticMap) CachedSize(alloc bool) int64

func (*NumericStaticMap) Cost 

func (*NumericStaticMap) Cost() int

Cost returns the cost of this vindex as 1.

func (*NumericStaticMap) Hash added in v0.13.0 

func (vind *NumericStaticMap) Hash(id sqltypes.Value) ([]byte, error)

func (*NumericStaticMap) IsUnique 

func (vind *NumericStaticMap) IsUnique() bool

IsUnique returns true since the Vindex is unique.

func (*NumericStaticMap) Map 

func (vind *NumericStaticMap) Map(ctx context.Context, vcursor VCursor, ids []sqltypes.Value) ([]key.Destination, error)

Map can map ids to key.Destination objects.

func (*NumericStaticMap) NeedsVCursor 

func (vind *NumericStaticMap) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*NumericStaticMap) String 

func (vind *NumericStaticMap) String() string

String returns the name of the vindex.

func (*NumericStaticMap) UnknownParams added in v0.18.0 

func (vind *NumericStaticMap) UnknownParams() []string

UnknownParams implements the ParamValidating interface.

func (*NumericStaticMap) Verify 

func (vind *NumericStaticMap) Verify(ctx context.Context, vcursor VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify returns true if ids and ksids match.

type ParamValidating added in v0.18.0 

type ParamValidating interface {
	// UnknownParams returns a slice of param names that were provided
	// during Vindex creation, but were not known and therefore ignored by
	// the Vindex.
	UnknownParams() []string
}

ParamValidating is an optional interface that Vindexes may implement to report errors about unknown params encountered during Vindex creation.

type ParamValidationOpts added in v0.18.0 

type ParamValidationOpts struct {
	// Params contains param names known by the vindex.
	Params []string
}

ParamValidationOpts may be used by Vindexes that accept params to validate params with ValidateParams(params, opts).

type ParentFKInfo added in v0.18.0 

type ParentFKInfo struct {
	Table         *Table
	ParentColumns sqlparser.Columns
	ChildColumns  sqlparser.Columns
}

ParentFKInfo contains the parent foreign key info for the table.

func NewParentFkInfo added in v0.18.0 

func NewParentFkInfo(parentTbl *Table, fkDef *sqlparser.ForeignKeyDefinition) ParentFKInfo

NewParentFkInfo creates a new ParentFKInfo.

func (*ParentFKInfo) MarshalJSON added in v0.18.0 

func (fk *ParentFKInfo) MarshalJSON() ([]byte, error)

MarshalJSON returns a JSON representation of ParentFKInfo.

func (*ParentFKInfo) String added in v0.18.0 

func (fk *ParentFKInfo) String(childTable *Table) string

type Prefixable added in v0.11.0 

type Prefixable interface {
	SingleColumn
	PrefixVindex() SingleColumn
}

A Prefixable vindex is one that maps the prefix of a id to a keyspace range instead of a single keyspace id. It's being used to reduced the fan out for 'LIKE' expressions.

type RegionExperimental 

type RegionExperimental struct {
	// contains filtered or unexported fields
}

RegionExperimental is a multi-column unique vindex. The first column is prefixed to the hash of the second column to produce the keyspace id. RegionExperimental can be used for geo-partitioning because the first column can denote a region, and its value will dictate the shard for that region.

func (*RegionExperimental) CachedSize added in v0.10.0 

func (cached *RegionExperimental) CachedSize(alloc bool) int64

func (*RegionExperimental) Cost 

func (ge *RegionExperimental) Cost() int

Cost returns the cost of this index as 1.

func (*RegionExperimental) IsUnique 

func (ge *RegionExperimental) IsUnique() bool

IsUnique returns true since the Vindex is unique.

func (*RegionExperimental) Map 

func (ge *RegionExperimental) Map(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value) ([]key.Destination, error)

Map satisfies MultiColumn.

func (*RegionExperimental) NeedsVCursor 

func (ge *RegionExperimental) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*RegionExperimental) PartialVindex added in v0.13.0 

func (ge *RegionExperimental) PartialVindex() bool

func (*RegionExperimental) String 

func (ge *RegionExperimental) String() string

String returns the name of the vindex.

func (*RegionExperimental) UnknownParams added in v0.18.0 

func (ge *RegionExperimental) UnknownParams() []string

UnknownParams implements the ParamValidating interface.

func (*RegionExperimental) Verify 

func (ge *RegionExperimental) Verify(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify satisfies MultiColumn.

type RegionJSON 

type RegionJSON struct {
	// contains filtered or unexported fields
}

RegionJSON is a multi-column unique vindex The first column is used to lookup the prefix part of the keyspace id, the second column is hashed, and the two values are combined to produce the keyspace id. RegionJson can be used for geo-partitioning because the first column can denote a region, and it will dictate the shard range for that region.

func (*RegionJSON) CachedSize added in v0.10.0 

func (cached *RegionJSON) CachedSize(alloc bool) int64

func (*RegionJSON) Cost 

func (rv *RegionJSON) Cost() int

Cost returns the cost of this index as 1.

func (*RegionJSON) IsUnique 

func (rv *RegionJSON) IsUnique() bool

IsUnique returns true since the Vindex is unique.

func (*RegionJSON) Map 

func (rv *RegionJSON) Map(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value) ([]key.Destination, error)

Map satisfies MultiColumn.

func (*RegionJSON) NeedsVCursor 

func (rv *RegionJSON) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*RegionJSON) PartialVindex added in v0.13.0 

func (rv *RegionJSON) PartialVindex() bool

func (*RegionJSON) String 

func (rv *RegionJSON) String() string

String returns the name of the vindex.

func (*RegionJSON) UnknownParams added in v0.18.0 

func (rv *RegionJSON) UnknownParams() []string

UnknownParams implements the ParamValidating interface.

func (*RegionJSON) Verify 

func (rv *RegionJSON) Verify(ctx context.Context, vcursor VCursor, rowsColValues [][]sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify satisfies MultiColumn

type RegionMap 

type RegionMap map[string]uint64

RegionMap is used to store mapping of country to region

type ReverseBits 

type ReverseBits struct {
	// contains filtered or unexported fields
}

ReverseBits defines vindex that reverses the bits of a number. It's Unique, Reversible and Functional.

func (*ReverseBits) CachedSize added in v0.10.0 

func (cached *ReverseBits) CachedSize(alloc bool) int64

func (*ReverseBits) Cost 

func (vind *ReverseBits) Cost() int

Cost returns the cost of this index as 1.

func (*ReverseBits) Hash added in v0.13.0 

func (vind *ReverseBits) Hash(id sqltypes.Value) ([]byte, error)

func (*ReverseBits) IsUnique 

func (vind *ReverseBits) IsUnique() bool

IsUnique returns true since the Vindex is unique.

func (*ReverseBits) Map 

func (vind *ReverseBits) Map(ctx context.Context, vcursor VCursor, ids []sqltypes.Value) ([]key.Destination, error)

Map returns the corresponding KeyspaceId values for the given ids.

func (*ReverseBits) NeedsVCursor 

func (vind *ReverseBits) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*ReverseBits) ReverseMap 

func (vind *ReverseBits) ReverseMap(_ VCursor, ksids [][]byte) ([]sqltypes.Value, error)

ReverseMap returns the ids from ksids.

func (*ReverseBits) String 

func (vind *ReverseBits) String() string

String returns the name of the vindex.

func (*ReverseBits) UnknownParams added in v0.18.0 

func (vind *ReverseBits) UnknownParams() []string

UnknownParams implements the ParamValidating interface.

func (*ReverseBits) Verify 

func (vind *ReverseBits) Verify(ctx context.Context, vcursor VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify returns true if ids maps to ksids.

type Reversible 

type Reversible interface {
	SingleColumn
	ReverseMap(vcursor VCursor, ks [][]byte) ([]sqltypes.Value, error)
}

A Reversible vindex is one that can perform a reverse lookup from a keyspace id to an id. This is optional. If present, VTGate can use it to fill column values based on the target keyspace id. Reversible is supported only for SingleColumn vindexes.

type RoutingRule 

type RoutingRule struct {
	Tables []*Table
	Error  error
}

RoutingRule represents one routing rule.

func (*RoutingRule) MarshalJSON 

func (rr *RoutingRule) MarshalJSON() ([]byte, error)

MarshalJSON returns a JSON representation of Column.

type SingleColumn 

type SingleColumn interface {
	Vindex
	// Map can map ids to key.Destination objects.
	// If the Vindex is unique, each id would map to either
	// a KeyRange, or a single KeyspaceID.
	// If the Vindex is non-unique, each id would map to either
	// a KeyRange, or a list of KeyspaceID.
	Map(ctx context.Context, vcursor VCursor, ids []sqltypes.Value) ([]key.Destination, error)

	// Verify returns true for every id that successfully maps to the
	// specified keyspace id.
	Verify(ctx context.Context, vcursor VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error)
}

SingleColumn defines the interface for a single column vindex.

type Source added in v0.16.0 

type Source struct {
	sqlparser.TableName
}

func (*Source) String added in v0.16.0 

func (source *Source) String() string

type Table 

type Table struct {
	Type                    string                 `json:"type,omitempty"`
	Name                    sqlparser.IdentifierCS `json:"name"`
	Keyspace                *Keyspace              `json:"-"`
	ColumnVindexes          []*ColumnVindex        `json:"column_vindexes,omitempty"`
	Ordered                 []*ColumnVindex        `json:"ordered,omitempty"`
	Owned                   []*ColumnVindex        `json:"owned,omitempty"`
	AutoIncrement           *AutoIncrement         `json:"auto_increment,omitempty"`
	Columns                 []Column               `json:"columns,omitempty"`
	Pinned                  []byte                 `json:"pinned,omitempty"`
	ColumnListAuthoritative bool                   `json:"column_list_authoritative,omitempty"`
	// ReferencedBy is an inverse mapping of tables in other keyspaces that
	// reference this table via Source.
	//
	// This is useful in route-planning for quickly selecting the optimal route
	// when JOIN-ing a reference table to a sharded table.
	ReferencedBy map[string]*Table `json:"-"`
	// Source is a keyspace-qualified table name that points to the source of a
	// reference table. Only applicable for tables with Type set to "reference".
	Source *Source `json:"source,omitempty"`

	ChildForeignKeys  []ChildFKInfo  `json:"child_foreign_keys,omitempty"`
	ParentForeignKeys []ParentFKInfo `json:"parent_foreign_keys,omitempty"`

	// index can be columns or expression.
	// For Primary key, functional indexes are not allowed, therefore it will only be columns.
	// MySQL error message: ERROR 3756 (HY000): The primary key cannot be a functional index
	PrimaryKey sqlparser.Columns `json:"primary_key,omitempty"`
	UniqueKeys []sqlparser.Exprs `json:"unique_keys,omitempty"`
}

Table represents a table in VSchema.

func (*Table) GetTableName added in v0.18.0 

func (t *Table) GetTableName() sqlparser.TableName

GetTableName gets the sqlparser.TableName for the vindex Table.

func (*Table) String added in v0.16.0 

func (t *Table) String() string

String prints the (possibly qualified) table name

type TableInfo added in v0.18.0 

type TableInfo struct {
	Columns     []Column
	ForeignKeys []*sqlparser.ForeignKeyDefinition
	Indexes     []*sqlparser.IndexDefinition
}

TableInfo contains column and foreign key info for a table.

type UnicodeLooseMD5 

type UnicodeLooseMD5 struct {
	// contains filtered or unexported fields
}

UnicodeLooseMD5 is a vindex that normalizes and hashes unicode strings to a keyspace id. It conservatively converts the string to its base characters before hashing. This is also known as UCA level 1. Ref: http://www.unicode.org/reports/tr10/#Multi_Level_Comparison. This is compatible with MySQL's utf8_unicode_ci collation.

func (*UnicodeLooseMD5) CachedSize added in v0.10.0 

func (cached *UnicodeLooseMD5) CachedSize(alloc bool) int64

func (*UnicodeLooseMD5) Cost 

func (vind *UnicodeLooseMD5) Cost() int

Cost returns the cost as 1.

func (*UnicodeLooseMD5) Hash added in v0.13.0 

func (vind *UnicodeLooseMD5) Hash(id sqltypes.Value) ([]byte, error)

func (*UnicodeLooseMD5) IsUnique 

func (vind *UnicodeLooseMD5) IsUnique() bool

IsUnique returns true since the Vindex is unique.

func (*UnicodeLooseMD5) Map 

func (vind *UnicodeLooseMD5) Map(ctx context.Context, vcursor VCursor, ids []sqltypes.Value) ([]key.Destination, error)

Map can map ids to key.Destination objects.

func (*UnicodeLooseMD5) NeedsVCursor 

func (vind *UnicodeLooseMD5) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*UnicodeLooseMD5) String 

func (vind *UnicodeLooseMD5) String() string

String returns the name of the vindex.

func (*UnicodeLooseMD5) UnknownParams added in v0.18.0 

func (vind *UnicodeLooseMD5) UnknownParams() []string

UnknownParams implements the ParamValidating interface.

func (*UnicodeLooseMD5) Verify 

func (vind *UnicodeLooseMD5) Verify(ctx context.Context, vcursor VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify returns true if ids maps to ksids.

type UnicodeLooseXXHash added in v0.8.0 

type UnicodeLooseXXHash struct {
	// contains filtered or unexported fields
}

UnicodeLooseXXHash is a vindex that normalizes and hashes unicode strings to a keyspace id. It conservatively converts the string to its base characters before hashing. This is also known as UCA level 1. Ref: http://www.unicode.org/reports/tr10/#Multi_Level_Comparison. This is compatible with MySQL's utf8_unicode_ci collation.

func (*UnicodeLooseXXHash) CachedSize added in v0.10.0 

func (cached *UnicodeLooseXXHash) CachedSize(alloc bool) int64

func (*UnicodeLooseXXHash) Cost added in v0.8.0 

func (vind *UnicodeLooseXXHash) Cost() int

Cost returns the cost as 1.

func (*UnicodeLooseXXHash) Hash added in v0.13.0 

func (vind *UnicodeLooseXXHash) Hash(id sqltypes.Value) ([]byte, error)

func (*UnicodeLooseXXHash) IsUnique added in v0.8.0 

func (vind *UnicodeLooseXXHash) IsUnique() bool

IsUnique returns true since the Vindex is unique.

func (*UnicodeLooseXXHash) Map added in v0.8.0 

func (vind *UnicodeLooseXXHash) Map(ctx context.Context, vcursor VCursor, ids []sqltypes.Value) ([]key.Destination, error)

Map can map ids to key.Destination objects.

func (*UnicodeLooseXXHash) NeedsVCursor added in v0.8.0 

func (vind *UnicodeLooseXXHash) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*UnicodeLooseXXHash) String added in v0.8.0 

func (vind *UnicodeLooseXXHash) String() string

String returns the name of the vindex.

func (*UnicodeLooseXXHash) UnknownParams added in v0.18.0 

func (vind *UnicodeLooseXXHash) UnknownParams() []string

UnknownParams implements the ParamValidating interface.

func (*UnicodeLooseXXHash) Verify added in v0.8.0 

func (vind *UnicodeLooseXXHash) Verify(ctx context.Context, vcursor VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify returns true if ids maps to ksids.

type VCursor 

type VCursor interface {
	Execute(ctx context.Context, method string, query string, bindvars map[string]*querypb.BindVariable, rollbackOnError bool, co vtgatepb.CommitOrder) (*sqltypes.Result, error)
	ExecuteKeyspaceID(ctx context.Context, keyspace string, ksid []byte, query string, bindVars map[string]*querypb.BindVariable, rollbackOnError, autocommit bool) (*sqltypes.Result, error)
	InTransactionAndIsDML() bool
	LookupRowLockShardSession() vtgatepb.CommitOrder
	ConnCollation() collations.ID
	Environment() *vtenv.Environment
}

A VCursor is an interface that allows you to execute queries in the current context and session of a VTGate request. Vindexes can use this interface to execute lookup queries.

type VSchema 

type VSchema struct {
	RoutingRules map[string]*RoutingRule `json:"routing_rules"`

	Keyspaces            map[string]*KeyspaceSchema `json:"keyspaces"`
	ShardRoutingRules    map[string]string          `json:"shard_routing_rules"`
	KeyspaceRoutingRules map[string]string          `json:"keyspace_routing_rules"`
	// contains filtered or unexported fields
}

VSchema represents the denormalized version of SrvVSchema, used for building routing plans.

func BuildVSchema 

func BuildVSchema(source *vschemapb.SrvVSchema, parser *sqlparser.Parser) (vschema *VSchema)

BuildVSchema builds a VSchema from a SrvVSchema.

func (*VSchema) AddForeignKey added in v0.18.0 

func (vschema *VSchema) AddForeignKey(ksname, childTableName string, fkConstraint *sqlparser.ForeignKeyDefinition) error

AddForeignKey is for testing only.

func (*VSchema) AddPrimaryKey added in v0.19.0 

func (vschema *VSchema) AddPrimaryKey(ksname, tblName string, cols []string) error

AddPrimaryKey is for testing only.

func (*VSchema) AddUDF added in v0.20.0 

func (vschema *VSchema) AddUDF(ksname, udfName string) error

AddUDF adds a UDF to an existing keyspace in the VSchema. It's only used from tests.

func (*VSchema) AddUniqueKey added in v0.19.0 

func (vschema *VSchema) AddUniqueKey(ksname, tblName string, exprs sqlparser.Exprs) error

AddUniqueKey is for testing only.

func (*VSchema) AddView added in v0.16.0 

func (vschema *VSchema) AddView(ksname, viewName, query string, parser *sqlparser.Parser) error

AddView adds a view to an existing keyspace in the VSchema. It's only used from tests.

func (*VSchema) FindRoutedShard added in v0.15.0 

func (vschema *VSchema) FindRoutedShard(keyspace, shard string) (string, error)

FindRoutedShard looks up shard routing rules and returns the target keyspace if applicable

func (*VSchema) FindRoutedTable added in v0.9.0 

func (vschema *VSchema) FindRoutedTable(keyspace, tablename string, tabletType topodatapb.TabletType) (*Table, error)

FindRoutedTable finds a table checking the routing rules.

func (*VSchema) FindTable 

func (vschema *VSchema) FindTable(keyspace, tablename string) (*Table, error)

FindTable returns a pointer to the Table. If a keyspace is specified, only tables from that keyspace are searched. If the specified keyspace is unsharded and no tables matched, it's considered valid: FindTable will construct a table of that name and return it. If no keyspace is specified, then a table is returned only if its name is unique across all keyspaces. If there is only one keyspace in the vschema, and it's unsharded, then all table requests are considered valid and belonging to that keyspace. FindTable bypasses routing rules and returns at most one table.

func (*VSchema) FindTableOrVindex added in v0.8.0 

func (vschema *VSchema) FindTableOrVindex(keyspace, name string, tabletType topodatapb.TabletType) (*Table, Vindex, error)

FindTableOrVindex finds a table or a Vindex by name using Find and FindVindex.

func (*VSchema) FindView added in v0.16.0 

func (vschema *VSchema) FindView(keyspace, name string) sqlparser.SelectStatement

func (*VSchema) FindVindex 

func (vschema *VSchema) FindVindex(keyspace, name string) (Vindex, error)

FindVindex finds a vindex by name. If a keyspace is specified, only vindexes from that keyspace are searched. If no kesypace is specified, then a vindex is returned only if its name is unique across all keyspaces. The function returns an error only if the vindex name is ambiguous.

func (*VSchema) FirstKeyspace added in v0.17.0 

func (vschema *VSchema) FirstKeyspace() *Keyspace

func (*VSchema) GetAggregateUDFs added in v0.20.0 

func (vschema *VSchema) GetAggregateUDFs() (udfs []string)

func (*VSchema) GetCreated added in v0.18.0 

func (vschema *VSchema) GetCreated() time.Time

GetCreated returns the time when the VSchema was created.

func (*VSchema) ResetCreated added in v0.18.0 

func (vschema *VSchema) ResetCreated()

ResetCreated resets the created time to zero value. Used only in tests where vschema protos are compared.

type Vindex 

type Vindex interface {
	// String returns the name of the Vindex instance.
	// It's used for testing and diagnostics. Use pointer
	// comparison to see if two objects refer to the same
	// Vindex.
	String() string

	// Cost is used by planbuilder to prioritize vindexes.
	// The cost can be 0 if the id is basically a keyspace id.
	// The cost can be 1 if the id can be hashed to a keyspace id.
	// The cost can be 2 or above if the id needs to be looked up
	// from an external data source. These guidelines are subject
	// to change in the future.
	Cost() int

	// IsUnique returns true if the Vindex is unique.
	// A Unique Vindex is allowed to return non-unique values like
	// a keyrange. This is in situations where the vindex does not
	// have enough information to map to a keyspace id. If so, such
	// a vindex cannot be primary.
	IsUnique() bool

	// NeedsVCursor returns true if the Vindex makes calls into the
	// VCursor. Such vindexes cannot be used by vreplication.
	NeedsVCursor() bool
}

Vindex defines the interface required to register a vindex.

func CreateVindex 

func CreateVindex(vindexType, name string, params map[string]string) (vindex Vindex, err error)

CreateVindex creates a vindex of the specified type using the supplied params. The type must have been previously registered.

type WantOwnerInfo 

type WantOwnerInfo interface {
	SetOwnerInfo(keyspace, table string, cols []sqlparser.IdentifierCI) error
}

WantOwnerInfo defines the interface that a vindex must satisfy to request info about the owner table. This information can be used to query the owner's table for the owning row's presence.

type XXHash 

type XXHash struct {
	// contains filtered or unexported fields
}

XXHash defines vindex that hashes any sql types to a KeyspaceId by using xxhash64. It's Unique and works on any platform giving identical result.

func (*XXHash) CachedSize added in v0.10.0 

func (cached *XXHash) CachedSize(alloc bool) int64

func (*XXHash) Cost 

func (vind *XXHash) Cost() int

Cost returns the cost of this index as 1.

func (*XXHash) Hash added in v0.13.0 

func (vind *XXHash) Hash(id sqltypes.Value) ([]byte, error)

func (*XXHash) IsUnique 

func (vind *XXHash) IsUnique() bool

IsUnique returns true since the Vindex is unique.

func (*XXHash) Map 

func (vind *XXHash) Map(ctx context.Context, vcursor VCursor, ids []sqltypes.Value) ([]key.Destination, error)

Map can map ids to key.Destination objects.

func (*XXHash) NeedsVCursor 

func (vind *XXHash) NeedsVCursor() bool

NeedsVCursor satisfies the Vindex interface.

func (*XXHash) String 

func (vind *XXHash) String() string

String returns the name of the vindex.

func (*XXHash) UnknownParams added in v0.18.0 

func (vind *XXHash) UnknownParams() []string

UnknownParams implements the ParamValidating interface.

func (*XXHash) Verify 

func (vind *XXHash) Verify(ctx context.Context, vcursor VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error)

Verify returns true if ids maps to ksids.

type XXHashBigEndian added in v0.19.0 

type XXHashBigEndian struct {
	*xxhash.Digest
}

func (XXHashBigEndian) Sum added in v0.19.0 

func (d XXHashBigEndian) Sum(b []byte) []byte

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.