tablecli

README

tablecli

Relational(Table) database client quick connecter

Documentation

Index

• Constants
• func CreateDatabaseIfNotExists(driverName, dataSourceName, databaseName string, ops ...Option) error
• func GormComment(description string) string
• func NewConnection(config *Config, ops ...Option) (*gorm.DB, error)
• func NewDataSourceName(host, username, password, database string, ops ...Option) string
• func NewDataSourceNameForConfig(config *Config, ops ...Option) string
• func NewDataSourceNameForNoSelectDatabase(host, username, password string, ops ...Option) string
• type Config
• type DriverName
  • func (d DriverName) String() string
• type Option
  • func WithCharset(charset string) Option
  • func WithDisableForeignKeyConstraintWhenMigrating(disable bool) Option
  • func WithDriverName(driverName DriverName) Option
  • func WithLocation(loc string) Option
  • func WithLogLevel(logLevel int) Option
  • func WithLogger(logger logger.Interface) Option
  • func WithNamingStrategy(strategy schema.NamingStrategy) Option
  • func WithParseTime(parseTime bool) Option

Constants

const (
	DefaultCreateBatchSize = 1000
)

Functions

func CreateDatabaseIfNotExists

func CreateDatabaseIfNotExists(driverName, dataSourceName, databaseName string,
	ops ...Option) error

CreateDatabaseIfNotExists If database not exists, then create it.

func GormComment

func GormComment(description string) string

GormComment get table comment for the description.

func NewConnection

func NewConnection(config *Config, ops ...Option) (*gorm.DB, error)

NewConnection create a new gorm db instance with the given options.

func NewDataSourceName

func NewDataSourceName(host, username, password, database string,
	ops ...Option) string

NewDataSourceName initialize database of the data source name. If database parameter is empty, will not choose database, such as only open database connection.

func NewDataSourceNameForConfig

func NewDataSourceNameForConfig(config *Config, ops ...Option) string

NewDataSourceNameForConfig Get data source name for given options.

func NewDataSourceNameForNoSelectDatabase

func NewDataSourceNameForNoSelectDatabase(host, username, password string,
	ops ...Option) string

Types

type Config

type Config struct {
	Host                  string
	Username              string
	Password              string
	Database              string
	MaxIdleConnections    int
	MaxOpenConnections    int
	MaxConnectionLifeTime time.Duration
}

Config defines config for database.

type DriverName

type DriverName string

const (
	DriverNameOfMySQL  DriverName = "mysql"
	DriverNameOfSQLite DriverName = "sqlite"
)

func (DriverName) String

func (d DriverName) String() string

type Option

type Option interface {
	// contains filtered or unexported methods
}

func WithCharset

func WithCharset(charset string) Option

func WithDisableForeignKeyConstraintWhenMigrating

func WithDisableForeignKeyConstraintWhenMigrating(disable bool) Option

func WithDriverName

func WithDriverName(driverName DriverName) Option

func WithLocation

func WithLocation(loc string) Option

func WithLogLevel

func WithLogLevel(logLevel int) Option

func WithLogger

func WithLogger(logger logger.Interface) Option

func WithNamingStrategy

func WithNamingStrategy(strategy schema.NamingStrategy) Option

func WithParseTime

func WithParseTime(parseTime bool) Option