doc.go

/*
Copyright 2022 Olivier Mengué

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

// Package sqlfunc provides utilities to wrap SQL prepared statements with strongly typed Go functions.
//
// You just have to define the function signature you need:
//
//	var whoami func(context.Context) (string, error)
//
// and the SQL statement that this function wraps:
//
//	close, err := sqlfunc.QueryRow(ctx, db, `SELECT USER()`, &whoami)  // MySQL example
//	defer close()
//
// You can now use the function:
//
//	user, err := whoami(ctx)
//	fmt.Println("Connected as", user)
package sqlfunc