catalog

Documentation

Overview

Package catalog provides catalog management for XxSql storage engine.

Index

• Constants
• type Catalog
  • func NewCatalog(dataDir string) *Catalog
  • func (c *Catalog) Close() error
  • func (c *Catalog) CreateFTSIndex(name, tableName string, columns []string, tokenizer string) error
  • func (c *Catalog) CreateTable(name string, columns []*types.ColumnInfo) error
  • func (c *Catalog) CreateTrigger(name string, timing, event int, tableName string, granularity int, ...) error
  • func (c *Catalog) CreateView(name string, query string, columns []string, checkOption string) error
  • func (c *Catalog) DropFTSIndex(name string) error
  • func (c *Catalog) DropTable(name string) error
  • func (c *Catalog) DropTrigger(name string) error
  • func (c *Catalog) DropView(name string) error
  • func (c *Catalog) FTSIndexExists(name string) bool
  • func (c *Catalog) Flush() error
  • func (c *Catalog) GetFTSIndex(name string) (*FTSInfo, error)
  • func (c *Catalog) GetFTSIndexesForTable(tableName string) []*FTSInfo
  • func (c *Catalog) GetTable(name string) (*table.Table, error)
  • func (c *Catalog) GetTableInfos() []*table.TableInfo
  • func (c *Catalog) GetTrigger(name string) (*TriggerInfo, error)
  • func (c *Catalog) GetTriggersForTable(tableName string, event int) []*TriggerInfo
  • func (c *Catalog) GetView(name string) (*ViewInfo, error)
  • func (c *Catalog) ListFTSIndexes() []string
  • func (c *Catalog) ListTables() []string
  • func (c *Catalog) ListTriggers() []string
  • func (c *Catalog) ListViews() []string
  • func (c *Catalog) Open() error
  • func (c *Catalog) RenameTable(oldName, newName string) error
  • func (c *Catalog) TableCount() int
  • func (c *Catalog) TableExists(name string) bool
  • func (c *Catalog) TriggerExists(name string) bool
  • func (c *Catalog) ViewExists(name string) bool
• type FTSInfo
• type TriggerInfo
• type ViewInfo

Constants

const (
	// CatalogFileName is the name of the catalog file.
	CatalogFileName = "catalog.json"
)

Types

type Catalog

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

Catalog manages all table metadata.

func NewCatalog

func NewCatalog(dataDir string) *Catalog

NewCatalog creates a new catalog.

func (*Catalog) Close

func (c *Catalog) Close() error

Close closes the catalog and all tables.

func (*Catalog) CreateFTSIndex

func (c *Catalog) CreateFTSIndex(name, tableName string, columns []string, tokenizer string) error

CreateFTSIndex creates a new FTS index.

func (*Catalog) CreateTable

func (c *Catalog) CreateTable(name string, columns []*types.ColumnInfo) error

CreateTable creates a new table.

func (*Catalog) CreateTrigger

func (c *Catalog) CreateTrigger(name string, timing, event int, tableName string, granularity int, whenClause, body string) error

CreateTrigger creates a new trigger.

func (*Catalog) CreateView

func (c *Catalog) CreateView(name string, query string, columns []string, checkOption string) error

CreateView creates a new view.

func (*Catalog) DropFTSIndex

func (c *Catalog) DropFTSIndex(name string) error

DropFTSIndex drops an FTS index.

func (*Catalog) DropTable

func (c *Catalog) DropTable(name string) error

DropTable drops a table.

func (*Catalog) DropTrigger

func (c *Catalog) DropTrigger(name string) error

DropTrigger drops a trigger.

func (*Catalog) DropView

func (c *Catalog) DropView(name string) error

DropView drops a view.

func (*Catalog) FTSIndexExists

func (c *Catalog) FTSIndexExists(name string) bool

FTSIndexExists checks if an FTS index exists.

func (*Catalog) Flush

func (c *Catalog) Flush() error

Flush flushes all tables to disk.

func (*Catalog) GetFTSIndex

func (c *Catalog) GetFTSIndex(name string) (*FTSInfo, error)

GetFTSIndex returns an FTS index by name.

func (*Catalog) GetFTSIndexesForTable

func (c *Catalog) GetFTSIndexesForTable(tableName string) []*FTSInfo

GetFTSIndexesForTable returns all FTS indexes for a table.

func (*Catalog) GetTable

func (c *Catalog) GetTable(name string) (*table.Table, error)

GetTable returns a table by name.

func (*Catalog) GetTableInfos

func (c *Catalog) GetTableInfos() []*table.TableInfo

GetTableInfos returns information about all tables.

func (*Catalog) GetTrigger

func (c *Catalog) GetTrigger(name string) (*TriggerInfo, error)

GetTrigger returns a trigger by name.

func (*Catalog) GetTriggersForTable

func (c *Catalog) GetTriggersForTable(tableName string, event int) []*TriggerInfo

GetTriggersForTable returns all triggers for a specific table and event.

func (*Catalog) GetView

func (c *Catalog) GetView(name string) (*ViewInfo, error)

GetView returns a view by name.

func (*Catalog) ListFTSIndexes

func (c *Catalog) ListFTSIndexes() []string

ListFTSIndexes returns all FTS index names.

func (*Catalog) ListTables

func (c *Catalog) ListTables() []string

ListTables returns all table names.

func (*Catalog) ListTriggers

func (c *Catalog) ListTriggers() []string

ListTriggers returns all trigger names.

func (*Catalog) ListViews

func (c *Catalog) ListViews() []string

ListViews returns all view names.

func (*Catalog) Open

func (c *Catalog) Open() error

Open opens the catalog and loads all tables.

func (*Catalog) RenameTable

func (c *Catalog) RenameTable(oldName, newName string) error

RenameTable renames a table.

func (*Catalog) TableCount

func (c *Catalog) TableCount() int

TableCount returns the number of tables.

func (*Catalog) TableExists

func (c *Catalog) TableExists(name string) bool

TableExists checks if a table exists.

func (*Catalog) TriggerExists

func (c *Catalog) TriggerExists(name string) bool

TriggerExists checks if a trigger exists.

func (*Catalog) ViewExists

func (c *Catalog) ViewExists(name string) bool

ViewExists checks if a view exists.

type FTSInfo

type FTSInfo struct {
	Name      string   // Index name
	TableName string   // Table name
	Columns   []string // Indexed columns
	Tokenizer string   // Tokenizer type
}

FTSInfo stores FTS index definition.

type TriggerInfo

type TriggerInfo struct {
	Name        string
	Timing      int // 0=BEFORE, 1=AFTER, 2=INSTEAD OF
	Event       int // 0=INSERT, 1=UPDATE, 2=DELETE
	TableName   string
	Granularity int // 0=FOR EACH ROW, 1=FOR EACH STATEMENT
	WhenClause  string
	Body        string
}

TriggerInfo stores trigger definition.

type ViewInfo

type ViewInfo struct {
	Name        string
	Query       string // The SQL query string
	Columns     []string
	CheckOption string // "CASCADED", "LOCAL", or "" (empty for no check)
}

ViewInfo stores view definition.