github.com/matrixorigin/matrixone@v1.2.0/pkg/txn/storage/memorystorage/catalog.go

// Copyright 2022 Matrix Origin
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package memorystorage

import (
	"fmt"

	"github.com/matrixorigin/matrixone/pkg/catalog"
	"github.com/matrixorigin/matrixone/pkg/container/types"
	"github.com/matrixorigin/matrixone/pkg/txn/storage/memorystorage/memorytable"
	"github.com/matrixorigin/matrixone/pkg/vm/engine"
	"github.com/matrixorigin/matrixone/pkg/vm/engine/memoryengine"
)

var (
	index_AccountID            = Text("account id")
	index_AccountID_Name       = Text("account id, name")
	index_DatabaseID           = Text("database id")
	index_DatabaseID_Name      = Text("database id, name")
	index_RelationID           = Text("relation id")
	index_RelationID_IsHidden  = Text("relation id, is hidden")
	index_RelationID_IsPrimary = Text("relation id, is primary")
	index_RelationID_Name      = Text("relation id, name")
	index_RowID                = Text("row id")
)

type (
	DatabaseRowIter  = Iter[ID, *DatabaseRow]
	RelationRowIter  = Iter[ID, *RelationRow]
	AttributeRowIter = Iter[ID, *AttributeRow]
)

type DatabaseRow struct {
	ID        ID
	AccountID uint32 // 0 is the sys account
	Name      []byte
	Typ       []byte
	CreateSql []byte
}

func (d *DatabaseRow) Key() ID {
	return d.ID
}

func (d *DatabaseRow) Value() *DatabaseRow {
	return d
}

func (d *DatabaseRow) Indexes() []Tuple {
	return []Tuple{
		{index_AccountID, Uint(d.AccountID)},
		{index_AccountID_Name, Uint(d.AccountID), Text(d.Name)},
	}
}

func (d *DatabaseRow) UniqueIndexes() []Tuple {
	return []Tuple{
		{index_AccountID_Name, Uint(d.AccountID), Text(d.Name)},
	}
}

var _ NamedRow = new(DatabaseRow)

func (d *DatabaseRow) AttrByName(handler *MemHandler, tx *Transaction, name string) (ret Nullable, err error) {
	defer func() {
		if ret.Value != nil {
			verifyAttr(catalog.MoDatabaseSchema, catalog.MoDatabaseTypes, name, ret.Value)
		}
	}()
	switch name {
	case catalog.SystemDBAttr_ID:
		ret.Value = uint64(d.ID)
	case catalog.SystemDBAttr_Name:
		ret.Value = d.Name
	case catalog.SystemDBAttr_CatalogName:
		ret.Value = []byte("")
	case catalog.SystemDBAttr_CreateSQL:
		ret.Value = []byte("")
	case catalog.SystemDBAttr_Owner:
		ret.Value = uint32(d.AccountID)
	case catalog.SystemDBAttr_Creator:
		ret.Value = uint32(d.AccountID)
	case catalog.SystemDBAttr_CreateAt:
		ret.Value = types.Timestamp(0)
	case catalog.SystemDBAttr_AccID:
		ret.Value = uint32(d.AccountID)
	case rowIDColumnName:
		ret.Value = d.ID.ToRowID()
	default:
		panic(fmt.Sprintf("fixme: %s", name))
	}
	return
}

type RelationRow struct {
	ID           ID
	DatabaseID   ID
	Name         []byte
	Type         memoryengine.RelationType
	Comments     []byte
	Properties   map[string]string
	Partitioned  int8   // 1 : the table has partitions. 0 : no partition
	PartitionDef []byte // partition info for the table has paritions
	ViewDef      []byte
	Constraint   []byte
}

func (r *RelationRow) Key() ID {
	return r.ID
}

func (r *RelationRow) Value() *RelationRow {
	return r
}

func (r *RelationRow) Indexes() []Tuple {
	return []Tuple{
		{index_DatabaseID, r.DatabaseID},
		{index_DatabaseID_Name, r.DatabaseID, Text(r.Name)},
	}
}

func (r *RelationRow) UniqueIndexes() []Tuple {
	return []Tuple{
		{index_DatabaseID_Name, r.DatabaseID, Text(r.Name)},
	}
}

var _ NamedRow = new(RelationRow)

func (r *RelationRow) AttrByName(handler *MemHandler, tx *Transaction, name string) (ret Nullable, err error) {
	defer func() {
		if ret.Value != nil {
			verifyAttr(catalog.MoDatabaseSchema, catalog.MoDatabaseTypes, name, ret.Value)
		}
	}()
	switch name {
	case catalog.SystemRelAttr_ID:
		ret.Value = uint64(r.ID)
	case catalog.SystemRelAttr_Name:
		ret.Value = r.Name
	case catalog.SystemRelAttr_DBID:
		if r.DatabaseID.IsEmpty() {
			ret.Value = uint64(0)
			return
		}
		db, err := handler.databases.Get(tx, r.DatabaseID)
		if err != nil {
			return ret, err
		}
		ret.Value = uint64(db.ID)
	case catalog.SystemRelAttr_DBName:
		if r.DatabaseID.IsEmpty() {
			ret.Value = []byte("")
			return
		}
		db, err := handler.databases.Get(tx, r.DatabaseID)
		if err != nil {
			return ret, err
		}
		ret.Value = db.Name
	case catalog.SystemRelAttr_Persistence:
		ret.Value = []byte("")
	case catalog.SystemRelAttr_Kind:
		ret.Value = []byte(r.Properties[catalog.SystemRelAttr_Kind]) // tae's logic
	case catalog.SystemRelAttr_Comment:
		ret.Value = r.Comments
	case catalog.SystemRelAttr_Partitioned:
		ret.Value = r.Partitioned
	case catalog.SystemRelAttr_Partition:
		ret.Value = r.PartitionDef
	case catalog.SystemRelAttr_CreateSQL:
		ret.Value = []byte(r.Properties[catalog.SystemRelAttr_CreateSQL]) // tae's logic
	case catalog.SystemRelAttr_Owner:
		ret.Value = uint32(0) //TODO
	case catalog.SystemRelAttr_Creator:
		ret.Value = uint32(0) //TODO
	case catalog.SystemRelAttr_CreateAt:
		ret.Value = types.Timestamp(0) //TODO
	case catalog.SystemRelAttr_AccID:
		ret.Value = uint32(0)
	case rowIDColumnName:
		ret.Value = r.ID.ToRowID()
	case catalog.SystemRelAttr_ViewDef:
		ret.Value = []byte(r.ViewDef)
	case catalog.SystemRelAttr_Constraint:
		ret.Value = r.Constraint
	default:
		panic(fmt.Sprintf("fixme: %s", name))
	}
	return
}

type AttributeRow struct {
	ID         ID
	RelationID ID
	Order      int
	Nullable   bool
	engine.Attribute
}

func (a *AttributeRow) Key() ID {
	return a.ID
}

func (a *AttributeRow) Value() *AttributeRow {
	return a
}

func (a *AttributeRow) Indexes() []Tuple {
	return []Tuple{
		{index_RelationID, a.RelationID},
		{index_RelationID_Name, a.RelationID, Text(a.Name)},
		{index_RelationID_IsPrimary, a.RelationID, Bool(a.Primary)},
		{index_RelationID_IsHidden, a.RelationID, Bool(a.IsHidden)},
	}
}

func (a *AttributeRow) UniqueIndexes() []Tuple {
	return []Tuple{
		{index_RelationID_Name, a.RelationID, Text(a.Name)},
	}
}

var _ NamedRow = new(AttributeRow)

func (a *AttributeRow) AttrByName(handler *MemHandler, tx *Transaction, name string) (ret Nullable, err error) {
	defer func() {
		if ret.Value != nil {
			verifyAttr(catalog.MoDatabaseSchema, catalog.MoDatabaseTypes, name, ret.Value)
		}
	}()
	switch name {
	case catalog.SystemColAttr_UniqName:
		ret.Value = []byte(a.Name)
	case catalog.SystemColAttr_AccID:
		ret.Value = uint32(0)
	case catalog.SystemColAttr_Name:
		ret.Value = []byte(a.Name)
	case catalog.SystemColAttr_DBID:
		rel, err := handler.relations.Get(tx, a.RelationID)
		if err != nil {
			return ret, err
		}
		if rel.DatabaseID.IsEmpty() {
			ret.Value = uint64(0)
			return ret, nil
		}
		db, err := handler.databases.Get(tx, rel.DatabaseID)
		if err != nil {
			return ret, err
		}
		ret.Value = uint64(db.ID)
	case catalog.SystemColAttr_DBName:
		rel, err := handler.relations.Get(tx, a.RelationID)
		if err != nil {
			return ret, err
		}
		if rel.DatabaseID.IsEmpty() {
			ret.Value = []byte("")
			return ret, nil
		}
		db, err := handler.databases.Get(tx, rel.DatabaseID)
		if err != nil {
			return ret, err
		}
		ret.Value = db.Name
	case catalog.SystemColAttr_RelID:
		ret.Value = uint64(a.RelationID)
	case catalog.SystemColAttr_RelName:
		rel, err := handler.relations.Get(tx, a.RelationID)
		if err != nil {
			return ret, err
		}
		ret.Value = rel.Name
	case catalog.SystemColAttr_Type:
		data, err := types.Encode(&a.Type)
		if err != nil {
			return ret, err
		}
		ret.Value = data
	case catalog.SystemColAttr_Num:
		ret.Value = int32(a.Order)
	case catalog.SystemColAttr_Length:
		ret.Value = int32(a.Type.TypeSize())
	case catalog.SystemColAttr_NullAbility:
		ret.Value = boolToInt8(a.Nullable)
	case catalog.SystemColAttr_HasExpr:
		ret.Value = boolToInt8(a.Default != nil)
	case catalog.SystemColAttr_DefaultExpr:
		if a.Default != nil {
			defaultExpr, err := types.Encode(a.Default)
			if err != nil {
				return ret, nil
			}
			ret.Value = defaultExpr
		} else {
			ret.Value = []byte("")
		}
	case catalog.SystemColAttr_HasUpdate:
		ret.Value = boolToInt8(a.OnUpdate != nil)
	case catalog.SystemColAttr_Update:
		if a.OnUpdate != nil {
			expr, err := types.Encode(a.OnUpdate)
			if err != nil {
				return ret, nil
			}
			ret.Value = expr
		} else {
			ret.Value = []byte("")
		}
	case catalog.SystemColAttr_IsDropped:
		ret.Value = boolToInt8(false)
	case catalog.SystemColAttr_ConstraintType:
		if a.Primary {
			ret.Value = []byte("p")
		} else {
			ret.Value = []byte("n")
		}
	case catalog.SystemColAttr_IsUnsigned:
		ret.Value = boolToInt8(a.Type.Oid == types.T_uint8 ||
			a.Type.Oid == types.T_uint16 ||
			a.Type.Oid == types.T_uint32 ||
			a.Type.Oid == types.T_uint64 ||
			a.Type.Oid == types.T_uint128)
	case catalog.SystemColAttr_IsAutoIncrement:
		ret.Value = boolToInt8(a.AutoIncrement)
	case catalog.SystemColAttr_IsHidden:
		ret.Value = boolToInt8(a.IsHidden)
	case catalog.SystemColAttr_Comment:
		ret.Value = []byte(a.Comment)
	case rowIDColumnName:
		ret.Value = a.ID.ToRowID()
	case catalog.SystemColAttr_IsClusterBy:
		ret.Value = boolToInt8(a.ClusterBy)
	default:
		panic(fmt.Sprintf("fixme: %s", name))
	}
	return
}

func verifyAttr(
	names []string,
	types []types.Type,
	name string,
	value any,
) {
	for i, attrName := range names {
		if attrName != name {
			continue
		}
		if value == nil {
			panic(fmt.Sprintf("%s should not be nil", attrName))
		}
		if !memorytable.TypeMatch(value, types[i].Oid) {
			panic(fmt.Sprintf("%s should be %v typed", name, types[i]))
		}
	}
}