sqlslog

func ConnExecContextErrorHandler ¶ added in v0.1.2

func ConnExecContextErrorHandler(driverName string) func(err error) (bool, []slog.Attr)

func ConnQueryContextErrorHandler ¶ added in v0.1.2

func ConnQueryContextErrorHandler(driverName string) func(err error) (bool, []slog.Attr)

func ConnectorConnectErrorHandler ¶ added in v0.1.2

func ConnectorConnectErrorHandler(driverName string) func(err error) (bool, []slog.Attr)

ConnectorConnectErrorHandler returns a function that handles the error of driver.Connector.Connect. The function returns completed and slice of slog.Attr.

# For Postgres: If err is nil, it returns true and a slice of slog.Attr{slog.Bool("eof", false)}. If err is io.EOF, it returns true and a slice of slog.Attr{slog.Bool("eof", true)}. Otherwise, it returns false and nil.

func DriverOpenErrorHandler ¶ added in v0.1.2

func DriverOpenErrorHandler(driverName string) func(err error) (bool, []slog.Attr)

DriverOpenErrorHandler returns a function that handles the error of driver.Driver.Open. The function returns completed and slice of slog.Attr.

# For Postgres: If err is nil, it returns true and a slice of slog.Attr{slog.Bool("eof", false)}. If err is io.EOF, it returns true and a slice of slog.Attr{slog.Bool("eof", true)}. Otherwise, it returns false and nil.

func HandleRowsNextError ¶ added in v0.1.2

func HandleRowsNextError(err error) (bool, []slog.Attr)

HandleRowsNextError returns completed and slice of slog.Attr. If err is nil, it returns true and a slice of slog.Attr{slog.Bool("eof", false)}. If err is io.EOF, it returns true and a slice of slog.Attr{slog.Bool("eof", true)}. Otherwise, it returns false and nil.

func NewJSONHandler ¶ added in v0.1.1

func NewJSONHandler(w io.Writer, opts *slog.HandlerOptions) *slog.JSONHandler

NewJSONHandler returns a new JSON handler by using slog.NewJSONHandler with custom options for sqlslog. See WrapHandlerOptions for the details of the options .

package main

import (
	"context"
	"log/slog"
	"os"

	sqlslog "github.com/akm/sql-slog"
)

func main() {
	dsn := "file::memory:?cache=shared"
	ctx := context.TODO()
	logger := slog.New(sqlslog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{
		Level: slog.LevelDebug,
	}))
	db, _ := sqlslog.Open(ctx, "sqlite3", dsn, sqlslog.Logger(logger))
	defer db.Close()
}

func NewTextHandler ¶ added in v0.1.1

func NewTextHandler(w io.Writer, opts *slog.HandlerOptions) *slog.TextHandler

NewTextHandler returns a new Text handler by using slog.NewTextHandler with custom options for sqlslog. See WrapHandlerOptions for the details of the options .

package main

import (
	"context"
	"log/slog"
	"os"

	sqlslog "github.com/akm/sql-slog"
)

func main() {
	dsn := "file::memory:?cache=shared"
	ctx := context.TODO()
	logger := slog.New(sqlslog.NewTextHandler(os.Stdout, nil))
	db, _ := sqlslog.Open(ctx, "sqlite3", dsn, sqlslog.Logger(logger))
	defer db.Close()
}

func Open ¶

func Open(ctx context.Context, driverName, dsn string, opts ...Option) (*sql.DB, error)

Open opens a database specified by its database driver name and a driver-specific data source name. And returns a new database handle with logger.

ctx is the context for the open operation. driverName is the name of the database driver as same as driverName of sql.Open. dsn is the data source name as same as dataSourceName of sql.Open. opts are the options for the logging behavior. See Option for the details.

The returned DB can be used as same as *sql.DB from sql.Open.

See the following example for the usage:

Logger: sets the slog.Logger to be used. If not set, the default is slog.Default().

StepOptions: sets the options for the logging behavior.

SetStepLogMsgFormatter: sets the function to format the step name.

package main

import (
	"context"

	sqlslog "github.com/akm/sql-slog"
)

func main() {
	dsn := "file::memory:?cache=shared"
	ctx := context.TODO()
	db, err := sqlslog.Open(ctx, "sqlite3", dsn)
	if err != nil {
		// Handle error
	}
	defer db.Close()
	// Use db as a regular *sql.DB
}

package main

import (
	"context"
	"log/slog"
	"os"

	sqlslog "github.com/akm/sql-slog"
)

func main() {
	dsn := "file::memory:?cache=shared"
	ctx := context.TODO()
	logger := slog.New(sqlslog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{
		Level: sqlslog.LevelTrace,
	}))
	db, _ := sqlslog.Open(ctx, "sqlite3", dsn, sqlslog.Logger(logger))
	defer db.Close()
}

package main

import (
	"context"
	"log/slog"
	"os"

	sqlslog "github.com/akm/sql-slog"
)

func main() {
	dsn := "file::memory:?cache=shared"
	ctx := context.TODO()
	logger := slog.New(sqlslog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{
		Level: sqlslog.LevelTrace,
	}))
	db, _ := sqlslog.Open(ctx, "sqlite3", dsn,
		sqlslog.Logger(logger),
		sqlslog.StmtQueryContext(func(o *sqlslog.StepOptions) {
			o.SetLevel(sqlslog.LevelDebug)
		}),
	)
	defer db.Close()
}

func ReplaceLevelAttr ¶ added in v0.1.1

func ReplaceLevelAttr(_ []string, a slog.Attr) slog.Attr

ReplaceLevelAttr replaces the log level as sqlslog.Level with the string representation.

func SetStepLogMsgFormatter ¶ added in v0.1.1

func SetStepLogMsgFormatter(f StepLogMsgFormatter)

SetStepLogMsgFormatter sets the formatter for the step name used in logs. If not set, the default is StepLogMsgWithEventName.

package main

import (
	"context"
	"log/slog"
	"os"

	sqlslog "github.com/akm/sql-slog"
)

func main() {
	sqlslog.SetStepLogMsgFormatter(func(name string, event sqlslog.Event) string {
		return name + "/" + event.String()
	})
	dsn := "file::memory:?cache=shared"
	ctx := context.TODO()
	logger := slog.New(sqlslog.NewJSONHandler(os.Stdout, nil))
	db, _ := sqlslog.Open(ctx, "sqlite3", dsn, sqlslog.Logger(logger))
	defer db.Close()
}

func StepLogMsgWithEventName ¶ added in v0.1.1

func StepLogMsgWithEventName(name string, event Event) string

StepLogMsgWithEventName returns the formatted step log message with the event name.

func WrapHandlerOptions ¶ added in v0.1.1

func WrapHandlerOptions(opts *slog.HandlerOptions) *slog.HandlerOptions

WrapHandlerOptions wraps the options with custom options for sqlslog. It merge ReplaceAttr functions with ReplaceLevelAttr.