tidbclient

Documentation

Overview

Package tidbclient provides a flexible TiDB API access to any TiDB instance.

Index

• Variables
• type SQLClient
  • func NewSQLClient(config SQLClientConfig) *SQLClient
  • func (c *SQLClient) OpenConn(user string, pass string) (*gorm.DB, error)
• type SQLClientConfig
• type StatusClient
  • func NewStatusClient(config httpclient.APIClientConfig) (*StatusClient, error)

Variables

var (
	ErrNS = errorx.NewNamespace("tidb_client")
	// ErrAuthFailed means the authentication is failed when connecting to the TiDB Server
	ErrAuthFailed = ErrNS.NewType("tidb_auth_failed")
	// ErrConnFailed means there is a connection (like network) problem when connecting to the TiDB Server
	ErrConnFailed = ErrNS.NewType("tidb_conn_failed")
)

Types

type SQLClient

type SQLClient struct {
	// contains filtered or unexported fields
}

func NewSQLClient

func NewSQLClient(config SQLClientConfig) *SQLClient

func (*SQLClient) OpenConn

func (c *SQLClient) OpenConn(user string, pass string) (*gorm.DB, error)

OpenConn opens a new connection. NOTICE: The opened connection must be manually closed.

type SQLClientConfig

type SQLClientConfig struct {
	BaseContext context.Context
	Host        string
	Port        int
	TLSKey      string
}

type StatusClient

type StatusClient struct {
	*httpclient.Client
}

func NewStatusClient

func NewStatusClient(config httpclient.APIClientConfig) (*StatusClient, error)

Returns error when config is invalid.