Should the golang implementation implement the SQL Valuer interface?

[jetpack-io]

Should the golang implementation implement the SQL Valuer interface?

[loreto]

Note that Scanner is another relevant interface for SQL integration.

[stevelizcano]

I recommend that this be done, because it makes typeIDs more difficult to wrangle if you are using a library like SQLC.

The issue is that if you do something like select * from my_table where id = 'some_id'; , you will get the typeID back. If you specify the sqlc type id like, for example:

      - db_type: "doc_id"
        go_type: "go.jetpack.io/typeid.TypeID"

It will try and coalesce the return string tuple into the TypeID. It fails, and panics.

Adding this ability—which I think is the Scan feature—would be very helpful.

I wrote this custom one myself to implement it:

type PGTypeID string

// ConvertToTypeID converts the PGTypeID to the typeid.TypeID.
func (p PGTypeID) ConvertToTypeID() (typeid.TypeID, error) {
	str := string(p)
	if !strings.HasPrefix(str, "(") || !strings.HasSuffix(str, ")") {
		return typeid.Nil, errors.New("invalid type id format")
	}

	// Remove the surrounding parentheses and replace the comma with an underscore
	// to match the format expected by FromString
	trimmed := strings.TrimSuffix(strings.TrimPrefix(str, "("), ")")
	trimmed = strings.Replace(trimmed, ",", "_", 1)

	// Use FromString to convert the trimmed string to TypeID
	return typeid.FromString(trimmed)
}

// Scan implements the sql.Scanner interface for PGTypeID.
func (p *PGTypeID) Scan(value interface{}) error {
	strVal, ok := value.(string)
	if !ok {
		return errors.New("PGTypeID must be a string")
	}
	*p = PGTypeID(strVal)
	return nil
}

// Value implements the driver.Valuer interface for PGTypeID.
func (p PGTypeID) Value() (driver.Value, error) {
	return string(p), nil
}

[loreto]

Recently committed a PR that adds this. Next release will have this built in.