clickhouse

README

ClickHouse

clickhouse://host:port?username=user&password=qwerty&database=clicks&x-multi-statement=true

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

Notes

• 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.

Documentation

Index

• Variables
• func WithInstance(conn *sql.DB, config *Config) (database.Driver, error)
• type ClickHouse
  • func (ch *ClickHouse) Close() error
  • func (ch *ClickHouse) Drop() error
  • func (ch *ClickHouse) Lock() error
  • func (ch *ClickHouse) Open(dsn string) (database.Driver, error)
  • func (ch *ClickHouse) Run(r io.Reader) error
  • func (ch *ClickHouse) SetVersion(version int, dirty bool) error
  • func (ch *ClickHouse) Unlock() error
  • func (ch *ClickHouse) Version() (int, bool, error)
• type Config

Variables

var DefaultMigrationsTable = "schema_migrations"

var ErrNilConfig = fmt.Errorf("no config")

Functions

func WithInstance

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

Types

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() 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
}