Version: v4.14.2-0...-29a845b Latest Latest

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

Go to latest
Published: Apr 13, 2021 License: MIT Imports: 13 Imported by: 0




URL Query Description
x-migrations-table Name of the migrations table
database The name of the database to connect to
username The user to sign in as
password The user's password
host The host to connect to.
port The port to bind to.
x-multi-statement false


  • The Clickhouse driver does not natively support executing multipe statements in a single query. To allow for multiple statements in a single migration, you can use the x-multi-statement param. There are two important caveats:
    • This mode splits the migration text into separately-executed statements by a semi-colon ;. Thus x-multi-statement cannot be used when a statement in the migration contains a string with a semi-colon.
    • The queries are not executed in any sort of transaction/batch, meaning you are responsible for fixing partial migrations.




This section is empty.


View Source
var (
	DefaultMigrationsTable       = "schema_migrations"
	DefaultMultiStatementMaxSize = 10 * 1 << 20 // 10 MB

	ErrNilConfig = fmt.Errorf("no config")


func WithInstance

func WithInstance(conn *sql.DB, config *Config) (database.Driver, error)


type ClickHouse

type ClickHouse struct {
	// contains filtered or unexported fields

func (*ClickHouse) Close

func (ch *ClickHouse) Close() error

func (*ClickHouse) Drop

func (ch *ClickHouse) Drop() (err error)

func (*ClickHouse) Lock

func (ch *ClickHouse) Lock() error

func (*ClickHouse) Open

func (ch *ClickHouse) Open(dsn string) (database.Driver, error)

func (*ClickHouse) Run

func (ch *ClickHouse) Run(r io.Reader) error

func (*ClickHouse) SetVersion

func (ch *ClickHouse) SetVersion(version int, dirty bool) error

func (*ClickHouse) Unlock

func (ch *ClickHouse) Unlock() error

func (*ClickHouse) Version

func (ch *ClickHouse) Version() (int, bool, error)

type Config

type Config struct {
	DatabaseName          string
	MigrationsTable       string
	MultiStatementEnabled bool
	MultiStatementMaxSize int

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto