clickhouse

package
v4.15.2 Latest Latest
Warning

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

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

README

ClickHouse

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

URL Query Description
x-migrations-table Name of the migrations table
x-migrations-table-engine Engine to use for the migrations table, defaults to TinyLog
x-cluster-name Name of cluster for creating schema_migrations table cluster wide
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.
  • Using the default TinyLog table engine for the schema_versions table prevents backing up the table if using the clickhouse-backup tool. If backing up the database with make sure the migrations are run with x-migrations-table-engine=MergeTree.
  • Clickhouse cluster mode is not officially supported, since it's not tested right now, but you can try enabling schema_migrations table replication by specifying a x-cluster-name:
    • When x-cluster-name is specified, x-migrations-table-engine also should be specified. See the docs regarding replicated table engines.
    • When x-cluster-name is specified, only the schema_migrations table is replicated across the cluster. You still need to write your migrations so that the application tables are replicated within the cluster.

Documentation

Index

Constants

This section is empty.

Variables

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

	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() (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
	ClusterName           string
	MigrationsTable       string
	MigrationsTableEngine string
	MultiStatementEnabled bool
	MultiStatementMaxSize int
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.