mysql

README

MySQL driver for Go

This is a MySQL driver for Go.

Docs

• Getting started with otelsql, the OpenTelemetry instrumentation for Go SQL

Documentation

Index

• Variables
• type Config
• type PingConnectionError
  • func (e *PingConnectionError) Error() string
• type Store
  • func New(tracer trace.TracerProvider, metrics *metric.MeterProvider) *Store
  • func (s *Store) GetConn() any
  • func (s *Store) Init(ctx context.Context) error
• type StoreError
  • func (e *StoreError) Error() string
  • func (e *StoreError) Unwrap() error

Variables

var (
	// ErrInvalidDSN indicates an invalid MySQL DSN.
	ErrInvalidDSN = errors.New("invalid MySQL DSN")
	// ErrClientConnection indicates a failure to connect to MySQL.
	ErrClientConnection = errors.New("failed to connect to MySQL server")
	// ErrInvalidDatabase indicates an invalid database name.
	ErrInvalidDatabase = errors.New("invalid database name")
	// ErrInvalidCredentials indicates invalid authentication credentials.
	ErrInvalidCredentials = errors.New("invalid MySQL credentials")
)

Error variables for wrapping underlying errors.

Types

type Config

type Config struct {
	URI string
}

Config - configuration

type PingConnectionError

type PingConnectionError struct {
	Err error
}

PingConnectionError - error ping connection

func (*PingConnectionError) Error

func (e *PingConnectionError) Error() string

type Store

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

Store implementation of db interface

func New

func New(tracer trace.TracerProvider, metrics *metric.MeterProvider) *Store

func (*Store) GetConn

func (s *Store) GetConn() any

GetConn - get connect

func (*Store) Init

func (s *Store) Init(ctx context.Context) error

Init - initialize

type StoreError

type StoreError struct {
	Op      string
	Err     error
	Details string
}

StoreError is a custom error type for Store operations with added details.

func (*StoreError) Error

func (e *StoreError) Error() string

Error implements the error interface.

func (*StoreError) Unwrap

func (e *StoreError) Unwrap() error

Unwrap allows errors.Is and errors.As to work with StoreError.