godatabend

Jan 9, 2026

Changes in this version

+ func Interval(t time.Duration) driver.Valuer

+ type BatchStmt struct

+ func PrepareBatch(query string) (stmt *BatchStmt, err error)

+ func (stmt *BatchStmt) ExecBatch(ctx context.Context, conn *sql.Conn, rows [][]driver.Value) (result driver.Result, err error)

type DatabendConn

+ func (dc *DatabendConn) ExecBatch(ctx context.Context, query string, rows [][]driver.Value) (driver.Result, error)

type QueryResponse

+ Settings *Settings

+ type Settings struct

+ GeometryOutputFormat string

+ TimeZone string

Nov 25, 2025

Changes in this version

type APIClient

+ func (c *APIClient) GetState() *APIClientState

+ func (c *APIClient) WithState(state *APIClientState) *APIClient

+ type APIClientState struct

+ Cookies map[string]*http.Cookie

+ NodeID string

+ RouteHint string

+ SessionID string

+ SessionState string

+ type ContextLogger interface

+ Infoln func(args ...interface{})

type DBLogger

+ Debugf func(format string, args ...interface{})

+ Error func(args ...interface{})

+ Info func(args ...interface{})

Jul 25, 2025

Changes in this version

type APIClient

+ func (c *APIClient) Verify(ctx context.Context) error

+ type VerifyResponse struct

+ Roles []string

+ Tenant string

+ User string

Apr 25, 2025

Changes in this version

+ type ColumnType interface

+ DatabaseTypeName func() string

+ Desc func() *TypeDesc

+ Length func() (int64, bool)

+ Nullable func() (bool, bool)

+ Parse func(s string) (driver.Value, error)

+ PrecisionScale func() (int64, int64, bool)

+ ScanType func() reflect.Type

+ func NewColumnType(dbType string, opts *ColumnTypeOptions) (ColumnType, error)

+ type ColumnTypeOptions struct

+ func (opt *ColumnTypeOptions) SetFormatNullAsStr(v bool)

+ func (opt *ColumnTypeOptions) SetTimezone(v *time.Location)

type Config

+ func (cfg *Config) Connect(ctx context.Context) (driver.Conn, error)

+ func (cfg *Config) Driver() driver.Driver

type DatabendDriver

+ func (d DatabendDriver) OpenConnector(dsn string) (driver.Connector, error)

type QueryError

+ Detail string

type TypeDesc

+ func (desc *TypeDesc) Normalize() *TypeDesc

Dec 11, 2024

Changes in this version

+ const DatabendQueryStickyNode

type APIClient

+ func (c *APIClient) Logout(ctx context.Context) error

+ func (c *APIClient) NeedKeepAlive() bool

+ func (c *APIClient) NeedSticky() bool

+ type IgnoreDomainCookieJar struct

+ func NewIgnoreDomainCookieJar() *IgnoreDomainCookieJar

+ func (jar *IgnoreDomainCookieJar) Cookies(u *url.URL) []*http.Cookie

+ func (jar *IgnoreDomainCookieJar) SetCookies(_u *url.URL, cookies []*http.Cookie)

type SessionState

+ NeedKeepAlive bool

+ NeedSticky bool

Aug 7, 2024

Changes in this version

type DataParser

+ Nullable func() bool

+ type NullableValue struct

+ func (nv *NullableValue) Scan(value any) error

+ func (nv NullableValue) Value() (driver.Value, error)

type TypeDesc

+ Nullable bool

Jul 23, 2024

Changes in this version

+ const DatabendRouteHintHeader

+ type TxnState string

+ const TxnStateActive

+ const TxnStateAutoCommit

Jun 13, 2024

Changes in this version

+ const DatabendQueryIDNode

type APIClient

+ NodeID string

type QueryResponse

+ NodeID string

May 15, 2024

Changes in this version

+ const ContextUserAgentID

Apr 22, 2024

Changes in this version

+ func NewAPIHttpClientFromConfig(cfg *Config) *http.Client

type APIClient

+ func (c *APIClient) CloseQuery(ctx context.Context, response *QueryResponse) error

+ func (c *APIClient) DoRetry(f retry.RetryableFunc, t RequestType) error

+ func (c *APIClient) PollQuery(ctx context.Context, nextURI string) (*QueryResponse, error)

+ func (c *APIClient) PollUntilQueryEnd(ctx context.Context, resp *QueryResponse) (*QueryResponse, error)

+ func (c *APIClient) StartQuery(ctx context.Context, query string, args []driver.Value) (*QueryResponse, error)

type Config

+ EnableOpenTelemetry bool

type QueryResponse

+ func (r *QueryResponse) ReadFinished() bool

+ type RequestType int

+ const Final

+ const Kill

+ const Page

+ const Query

Mar 21, 2024

Changes in this version

type APIClient

+ QuerySeq int64

+ SessionID string

+ func (c *APIClient) GetQueryID() string

+ func (c *APIClient) NextQuery()

Mar 5, 2024

Changes in this version

type DatabendConn

+ func (dc *DatabendConn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, error)

+ func (dc *DatabendConn) ExecuteBatch() (err error)

+ type ServerInfo struct

+ Id string

+ StartTime string

type SessionState

+ LastQueryIds []string

+ LastServerInfo ServerInfo

+ TxnState string

Feb 26, 2024

Changes in this version

type APIClient

+ func (c *APIClient) NewDefaultCSVFormatOptions() map[string]string

Feb 23, 2024

Changes in this version

+ const EMPTY_FIELD_AS

+ const PURGE

type APIClient

+ EmptyFieldAs string

+ func (c *APIClient) NewDefaultCopyOptions() map[string]string

type Config

+ EmptyFieldAs string

Jan 9, 2024

Changes in this version

+ type ContextKey string

type DatabendConn

+ func (dc *DatabendConn) Ping(ctx context.Context) error

Dec 18, 2023

Changes in this version

+ const Authorization

+ const ContextKeyQueryID

+ const DBSessionIDKey

+ const DatabendQueryIDHeader

+ const DatabendTenantHeader

+ const DatabendWarehouseHeader

+ const SFSessionUserKey

+ const SSL_MODE_DISABLE

+ const UserAgent

+ const WarehouseRoute

+ var ErrDoRequest = errors.New("DoReqeustFailed")

+ var ErrNoLastInsertID = errors.New("no LastInsertId available")

+ var ErrNoRowsAffected = errors.New("no RowsAffected available")

+ var ErrPlaceholderCount = errors.New("databend: wrong placeholder count")

+ var ErrReadResponse = errors.New("ReadResponseFailed")

+ var LogKeys = [...]contextKey

+ var ProvisionWarehouseTimeout = "ProvisionWarehouseTimeout"

+ func Array(v interface{}) driver.Valuer

+ func DBCallerPrettyfier(frame *runtime.Frame) (string, string)

+ func Date(t time.Time) driver.Valuer

+ func Decimal128(v interface{}, s int32) driver.Valuer

+ func Decimal32(v interface{}, s int32) driver.Valuer

+ func Decimal64(v interface{}, s int32) driver.Valuer

+ func DeregisterTLSConfig(key string)

+ func IP(i net.IP) driver.Valuer

+ func IsAuthFailed(err error) bool

+ func IsNotFound(err error) bool

+ func IsProxyErr(err error) bool

+ func Map(v interface{}) driver.Valuer

+ func NewAPIError(hint string, status int, respBuf []byte) error

+ func NewDefaultCSVFormatOptions() map[string]string

+ func NewDefaultCopyOptions() map[string]string

+ func RegisterTLSConfig(key string, config *tls.Config) error

+ func SetLogger(inLogger *DBLogger)

+ func Tuple(v interface{}) driver.Valuer

+ func UInt64(u uint64) driver.Valuer

+ type APIClient struct

+ MaxRowsInBuffer int64

+ MaxRowsPerPage int64

+ PresignedURLDisabled bool

+ WaitTimeSeconds int64

+ func NewAPIClientFromConfig(cfg *Config) *APIClient

+ func (c *APIClient) DoQuery(ctx context.Context, query string, args []driver.Value) (*QueryResponse, error)

+ func (c *APIClient) GetPresignedURL(ctx context.Context, stage *StageLocation) (*PresignedResponse, error)

+ func (c *APIClient) InsertWithStage(ctx context.Context, sql string, stage *StageLocation, ...) (*QueryResponse, error)

+ func (c *APIClient) KillQuery(ctx context.Context, killURI string) error

+ func (c *APIClient) QueryPage(ctx context.Context, nextURI string) (*QueryResponse, error)

+ func (c *APIClient) QuerySingle(ctx context.Context, query string, args []driver.Value) (*QueryResponse, error)

+ func (c *APIClient) QuerySync(ctx context.Context, query string, args []driver.Value, ...) error

+ func (c *APIClient) UploadToStage(ctx context.Context, stage *StageLocation, input *bufio.Reader, size int64) error

+ func (c *APIClient) UploadToStageByAPI(ctx context.Context, stage *StageLocation, input *bufio.Reader, size int64) error

+ func (c *APIClient) UploadToStageByPresignURL(ctx context.Context, stage *StageLocation, input *bufio.Reader, size int64) error

+ func (c *APIClient) WaitForQuery(ctx context.Context, result *QueryResponse) (*QueryResponse, error)

+ type APIError struct

+ Hint string

+ RespBody APIErrorResponseBody

+ RespText string

+ StatusCode int

+ func (e APIError) Error() string

+ type APIErrorResponseBody struct

+ Error string

+ Message string

+ func RespBody(err error) APIErrorResponseBody

+ type AccessTokenLoader interface

+ LoadAccessToken func(ctx context.Context, forceRotate bool) (string, error)

+ type AuthMethod string

+ const AuthMethodAccessToken

+ const AuthMethodUserPassword

+ type Batch interface

+ AppendToFile func(v []driver.Value) error

+ BatchInsert func() error

+ type Config struct

+ AccessToken string

+ AccessTokenFile string

+ AccessTokenLoader AccessTokenLoader

+ Database string

+ Debug bool

+ GzipCompression bool

+ Host string

+ Location *time.Location

+ MaxRowsInBuffer int64

+ MaxRowsPerPage int64

+ Params map[string]string

+ Password string

+ PresignedURLDisabled bool

+ Role string

+ SSLMode string

+ StatsTracker QueryStatsTracker

+ TLSConfig string

+ Tenant string

+ Timeout time.Duration

+ User string

+ WaitTimeSecs int64

+ Warehouse string

+ func NewConfig() *Config

+ func ParseDSN(dsn string) (*Config, error)

+ func (cfg *Config) AddParams(params map[string]string) (err error)

+ func (cfg *Config) FormatDSN() string

+ type DBLogger interface

+ SetLogLevel func(level string) error

+ SetOutput func(output io.Writer)

+ WithContext func(ctx context.Context) *rlog.Entry

+ func CreateDefaultLogger() DBLogger

+ func GetLogger() DBLogger

+ type DataField struct

+ Name string

+ Type string

+ type DataParser interface

+ Parse func(io.RuneScanner) (driver.Value, error)

+ Type func() reflect.Type

+ func NewDataParser(t *TypeDesc, opt *DataParserOptions) (DataParser, error)

+ type DataParserOptions struct

+ Location *time.Location

+ UseDBLocation bool

+ type DatabendConn struct

+ func (dc *DatabendConn) Begin() (driver.Tx, error)

+ func (dc *DatabendConn) Close() error

+ func (dc *DatabendConn) Commit() (err error)

+ func (dc *DatabendConn) Exec(query string, args []driver.Value) (driver.Result, error)

+ func (dc *DatabendConn) ExecContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Result, error)

+ func (dc *DatabendConn) Prepare(query string) (driver.Stmt, error)

+ func (dc *DatabendConn) PrepareContext(ctx context.Context, query string) (driver.Stmt, error)

+ func (dc *DatabendConn) Query(query string, args []driver.Value) (driver.Rows, error)

+ func (dc *DatabendConn) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Rows, error)

+ func (dc *DatabendConn) Rollback() error

+ type DatabendDriver struct

+ func (d DatabendDriver) Open(dsn string) (driver.Conn, error)

+ func (d DatabendDriver) OpenWithConfig(ctx context.Context, config Config) (driver.Conn, error)

+ type Error struct

+ Code int

+ Message string

+ func (e *Error) Error() string

+ type FileAccessTokenData struct

+ AccessToken string

+ type FileAccessTokenLoader struct

+ func NewFileAccessTokenLoader(path string) *FileAccessTokenLoader

+ func (l *FileAccessTokenLoader) LoadAccessToken(ctx context.Context, forceRotate bool) (string, error)

+ type PaginationConfig struct

+ MaxRowsInBuffer int64

+ MaxRowsPerPage int64

+ WaitTime int64

+ type PresignedResponse struct

+ Headers map[string]string

+ Method string

+ URL string

+ type QueryError struct

+ Code int

+ Kind string

+ Message string

+ func (e *QueryError) Error() string

+ type QueryIDGenerator func() string

+ type QueryProgress struct

+ Bytes uint64

+ Rows uint64

+ type QueryRequest struct

+ Pagination *PaginationConfig

+ SQL string

+ Session *SessionState

+ StageAttachment *StageAttachmentConfig

+ type QueryResponse struct

+ Data [][]string

+ Error *QueryError

+ FinalURI string

+ ID string

+ KillURI string

+ NextURI string

+ Schema []DataField

+ Session *SessionState

+ SessionID string

+ State string

+ Stats QueryStats

+ StatsURI string

+ type QueryStats struct

+ ResultProgress QueryProgress

+ RunningTimeMS float64

+ ScanProgress QueryProgress

+ WriteProgress QueryProgress

+ type QueryStatsTracker func(queryID string, stats *QueryStats)

+ type SessionState struct

+ Database string

+ Role string

+ SecondaryRoles *[]string

+ Settings map[string]string

+ type StageAttachmentConfig struct

+ CopyOptions map[string]string

+ FileFormatOptions map[string]string

+ Location string

+ type StageLocation struct

+ Name string

+ Path string

+ func (sl *StageLocation) String() string

+ type StaticAccessTokenLoader struct

+ AccessToken string

+ func NewStaticAccessTokenLoader(accessToken string) *StaticAccessTokenLoader

+ func (l *StaticAccessTokenLoader) LoadAccessToken(ctx context.Context, forceRotate bool) (string, error)

+ type TypeDesc struct

+ Args []*TypeDesc

+ Name string

+ func ParseTypeDesc(s string) (*TypeDesc, error)