Documentation ¶
Index ¶
- type BaseMigration
- func (m *BaseMigration) AddColumn(tableName, columnName string, columnI camStatics.MysqlColumnBuilderInterface)
- func (m *BaseMigration) AlterColumn(tableName, oldName, newName string, ...)
- func (m *BaseMigration) Bigint(sizes ...int) camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) BigintPrimaryKey() camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) Binary(sizes ...int) camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) Blob() camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) Char(sizes ...int) camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) Column(name string, columnI camStatics.MysqlColumnBuilderInterface) camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) CreateForeignKey(name, table string, columns []string, refTable string, refColumns []string)
- func (m *BaseMigration) CreateIndex(indexName, tableName string, columnNames ...string)
- func (m *BaseMigration) CreateTable(tableName string, columnList []camStatics.MysqlColumnBuilderInterface, ...)
- func (m *BaseMigration) CreateUnique(indexName, tableName string, columnNames ...string)
- func (m *BaseMigration) Datetime() camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) Decimal(sizes ...int) camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) DefaultOption(comment string) string
- func (m *BaseMigration) Double(sizes ...int) camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) DropColumn(tableName, columnName string)
- func (m *BaseMigration) DropIndex(tableName, indexName string)
- func (m *BaseMigration) DropTable(tableName string)
- func (m *BaseMigration) Exec(sql string)
- func (m *BaseMigration) Float(sizes ...int) camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) GetSqlList() []string
- func (m *BaseMigration) Int(sizes ...int) camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) IntPrimaryKey() camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) Longblob() camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) Longtext() camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) Mediumblob() camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) Mediumint(sizes ...int) camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) Mediumtext() camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) Option(comment, engine, charset, collate string) string
- func (m *BaseMigration) RenameColumn(tableName, oldName, newName string)
- func (m *BaseMigration) RenameTable(oldTableName, newTableName string)
- func (m *BaseMigration) Smallint(sizes ...int) camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) Text() camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) Timestamp() camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) Tinyblob() camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) Tinyint(sizes ...int) camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) Tinytext() camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) Varbinary(sizes ...int) camStatics.MysqlColumnBuilderInterface
- func (m *BaseMigration) Varchar(sizes ...int) camStatics.MysqlColumnBuilderInterface
- type ConsoleComponent
- func (comp *ConsoleComponent) GetMigrateUpVersionList() []string
- func (comp *ConsoleComponent) Init(configI camStatics.ComponentConfigInterface)
- func (comp *ConsoleComponent) MigrateDown()
- func (comp *ConsoleComponent) MigrateLastVersion() string
- func (comp *ConsoleComponent) MigrateUp()
- func (comp *ConsoleComponent) RunAction()
- type ConsoleComponentConfig
- type ConsoleController
- type GrpcController
- type GrpcOption
- type MigrateController
- type Migration
- type MigrationTpl
- type XormControllerdeprecated
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BaseMigration ¶
type BaseMigration struct { camStatics.MigrationInterface // contains filtered or unexported fields }
base migration struct
func (*BaseMigration) AddColumn ¶ added in v0.5.0
func (m *BaseMigration) AddColumn(tableName, columnName string, columnI camStatics.MysqlColumnBuilderInterface)
Add column for table
func (*BaseMigration) AlterColumn ¶ added in v0.5.0
func (m *BaseMigration) AlterColumn(tableName, oldName, newName string, column camStatics.MysqlColumnBuilderInterface)
Alter table
func (*BaseMigration) Bigint ¶ added in v0.5.0
func (m *BaseMigration) Bigint(sizes ...int) camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) BigintPrimaryKey ¶ added in v0.5.0
func (m *BaseMigration) BigintPrimaryKey() camStatics.MysqlColumnBuilderInterface
Set bigint type primary key
func (*BaseMigration) Binary ¶ added in v0.5.0
func (m *BaseMigration) Binary(sizes ...int) camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) Blob ¶ added in v0.5.0
func (m *BaseMigration) Blob() camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) Char ¶ added in v0.5.0
func (m *BaseMigration) Char(sizes ...int) camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) Column ¶ added in v0.5.0
func (m *BaseMigration) Column(name string, columnI camStatics.MysqlColumnBuilderInterface) camStatics.MysqlColumnBuilderInterface
Table column In order to keep table columns sort
func (*BaseMigration) CreateForeignKey ¶ added in v0.5.0
func (m *BaseMigration) CreateForeignKey(name, table string, columns []string, refTable string, refColumns []string)
Create foreign key
func (*BaseMigration) CreateIndex ¶ added in v0.5.0
func (m *BaseMigration) CreateIndex(indexName, tableName string, columnNames ...string)
Create index
func (*BaseMigration) CreateTable ¶ added in v0.5.0
func (m *BaseMigration) CreateTable(tableName string, columnList []camStatics.MysqlColumnBuilderInterface, options string)
Create table
Param options: a string after create table. Example: CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci ENGINE=InnoDB COMMENT = 'table comment'
func (*BaseMigration) CreateUnique ¶ added in v0.5.0
func (m *BaseMigration) CreateUnique(indexName, tableName string, columnNames ...string)
Create unique
func (*BaseMigration) Datetime ¶ added in v0.5.0
func (m *BaseMigration) Datetime() camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) Decimal ¶ added in v0.5.0
func (m *BaseMigration) Decimal(sizes ...int) camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) DefaultOption ¶ added in v0.5.0
func (m *BaseMigration) DefaultOption(comment string) string
func (*BaseMigration) Double ¶ added in v0.5.0
func (m *BaseMigration) Double(sizes ...int) camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) DropColumn ¶ added in v0.5.0
func (m *BaseMigration) DropColumn(tableName, columnName string)
Drop column
func (*BaseMigration) DropIndex ¶ added in v0.5.0
func (m *BaseMigration) DropIndex(tableName, indexName string)
Drop index
func (*BaseMigration) DropTable ¶ added in v0.5.0
func (m *BaseMigration) DropTable(tableName string)
Drop table
func (*BaseMigration) Float ¶ added in v0.5.0
func (m *BaseMigration) Float(sizes ...int) camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) Int ¶ added in v0.5.0
func (m *BaseMigration) Int(sizes ...int) camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) IntPrimaryKey ¶ added in v0.5.0
func (m *BaseMigration) IntPrimaryKey() camStatics.MysqlColumnBuilderInterface
Set int type primary key
func (*BaseMigration) Longblob ¶ added in v0.5.0
func (m *BaseMigration) Longblob() camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) Longtext ¶ added in v0.5.0
func (m *BaseMigration) Longtext() camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) Mediumblob ¶ added in v0.5.0
func (m *BaseMigration) Mediumblob() camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) Mediumint ¶ added in v0.5.0
func (m *BaseMigration) Mediumint(sizes ...int) camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) Mediumtext ¶ added in v0.5.0
func (m *BaseMigration) Mediumtext() camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) Option ¶ added in v0.5.0
func (m *BaseMigration) Option(comment, engine, charset, collate string) string
func (*BaseMigration) RenameColumn ¶ added in v0.5.0
func (m *BaseMigration) RenameColumn(tableName, oldName, newName string)
Rename column
func (*BaseMigration) RenameTable ¶ added in v0.5.0
func (m *BaseMigration) RenameTable(oldTableName, newTableName string)
Rename table
func (*BaseMigration) Smallint ¶ added in v0.5.0
func (m *BaseMigration) Smallint(sizes ...int) camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) Text ¶ added in v0.5.0
func (m *BaseMigration) Text() camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) Timestamp ¶ added in v0.5.0
func (m *BaseMigration) Timestamp() camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) Tinyblob ¶ added in v0.5.0
func (m *BaseMigration) Tinyblob() camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) Tinyint ¶ added in v0.5.0
func (m *BaseMigration) Tinyint(sizes ...int) camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) Tinytext ¶ added in v0.5.0
func (m *BaseMigration) Tinytext() camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) Varbinary ¶ added in v0.5.0
func (m *BaseMigration) Varbinary(sizes ...int) camStatics.MysqlColumnBuilderInterface
func (*BaseMigration) Varchar ¶ added in v0.5.0
func (m *BaseMigration) Varchar(sizes ...int) camStatics.MysqlColumnBuilderInterface
type ConsoleComponent ¶
type ConsoleComponent struct { component.Component camRouter.RouterPlugin camContext.ContextPlugin // contains filtered or unexported fields }
command component
func (*ConsoleComponent) GetMigrateUpVersionList ¶
func (comp *ConsoleComponent) GetMigrateUpVersionList() []string
get migrate up version list.
func (*ConsoleComponent) Init ¶
func (comp *ConsoleComponent) Init(configI camStatics.ComponentConfigInterface)
init
func (*ConsoleComponent) MigrateDown ¶
func (comp *ConsoleComponent) MigrateDown()
down last database version
func (*ConsoleComponent) MigrateLastVersion ¶
func (comp *ConsoleComponent) MigrateLastVersion() string
func (*ConsoleComponent) MigrateUp ¶
func (comp *ConsoleComponent) MigrateUp()
up all database version
func (*ConsoleComponent) RunAction ¶
func (comp *ConsoleComponent) RunAction()
run command Example:
# go build cam.go # ./cam controllerName/actionName param1 param2
type ConsoleComponentConfig ¶
type ConsoleComponentConfig struct { component.ComponentConfig camRouter.RouterPluginConfig camContext.ContextPluginConfig DatabaseDir string // DatabaseComponentConfig file storage path. Default is: /[path to run dir]/database XormTemplateDir string // Deprecated: xorm template path. // contains filtered or unexported fields }
console config
func NewConsoleComponentConfig ¶
func NewConsoleComponentConfig() *ConsoleComponentConfig
new console config
func (*ConsoleComponentConfig) SetDatabaseDir ¶
func (conf *ConsoleComponentConfig) SetDatabaseDir(dir string) *ConsoleComponentConfig
set migration's file dir
func (*ConsoleComponentConfig) SetGrpcOption ¶ added in v0.5.0
func (conf *ConsoleComponentConfig) SetGrpcOption(option *GrpcOption)
set grpc option
func (*ConsoleComponentConfig) SetXormTemplateDir ¶
func (conf *ConsoleComponentConfig) SetXormTemplateDir(dir string) *ConsoleComponentConfig
set xorm dir
type ConsoleController ¶
type ConsoleController struct {
camRouter.Controller
}
func (*ConsoleController) GetArgv ¶
func (ctrl *ConsoleController) GetArgv(key int) string
get params key start is 0 example:
/path/to/main.exe console/run argv0 argv1 controller.GetArgv(0) => "argv0" controller.GetArgv(1) => "argv1" controller.GetArgv(2) => "" controller.GetArgv(-1) => ""
func (*ConsoleController) GetConsoleComponent ¶
func (ctrl *ConsoleController) GetConsoleComponent() *ConsoleComponent
get console component
type GrpcController ¶ added in v0.5.0
type GrpcController struct {
ConsoleController
}
func (*GrpcController) DownloadProtocGenGo ¶ added in v0.5.0
func (ctrl *GrpcController) DownloadProtocGenGo()
type GrpcOption ¶ added in v0.5.0
type GrpcOption struct { // the module's dirs // // Example: []string{"backend-grpc", "center-grpc"} GrpcDirs []string }
type MigrateController ¶
type MigrateController struct {
ConsoleController
}
func (*MigrateController) Generate ¶ added in v0.5.1
func (ctrl *MigrateController) Generate()
Gen xorm model's files
func (*MigrateController) Install ¶ added in v0.5.1
func (ctrl *MigrateController) Install()
Install xorm reverse command
func (*MigrateController) Sync ¶ added in v0.5.0
func (ctrl *MigrateController) Sync()
type MigrationTpl ¶
type MigrationTpl struct {
ClassName string
}
type XormController
deprecated
type XormController struct {
ConsoleController
}
Deprecated: remove on v0.6.0 xorm's console controller
func (*XormController) BeforeAction ¶ added in v0.4.3
func (ctrl *XormController) BeforeAction(action camStatics.ControllerActionInterface) bool
OVERWRITE
func (*XormController) Generate ¶
func (ctrl *XormController) Generate()
Generate ORM classes automatically according to the database xorm reverse
usage: xorm reverse [-s] driverName datasourceName tmplPath [generatedPath] [tableFilterReg] according database's tables and columns to generate codes for Go, C++ and etc. -s Generated one go file for every table driverName Database driver name, now supported four: mysql mymysql sqlite3 postgres datasourceName Database connection uri, for detail infomation please visit driver's project page tmplPath Template dir for generated. the default templates dir has provide 1 template generatedPath This parameter is optional, if blank, the default value is model, then will generated all codes in model dir tableFilterReg Table name filter regexp
func (*XormController) InstallCmdXorm
deprecated
func (ctrl *XormController) InstallCmdXorm()
Deprecated: remove on v0.6.0 install github.com/go-xorm/cmd/xorm