catalog: use NewReferencedDescriptorNotFoundError

This is easier to remember than having to wrap the error at each call
site.

Release note: None

Author: rafiss

pkg/sql/catalog/errors.go

@@ -16,6 +16,7 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgerror"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/tree"
 	"github.com/cockroachdb/errors"
+	"github.com/cockroachdb/redact"
 )
 
 // ValidateName validates a name.
@@ -93,6 +94,10 @@ var ErrDescriptorNotFound = errors.New("descriptor not found")
 // descriptors referenced within another descriptor.
 var ErrReferencedDescriptorNotFound = errors.New("referenced descriptor not found")
 
+func NewReferencedDescriptorNotFoundError(descType string, id descpb.ID) error {
+	return errors.Wrapf(ErrReferencedDescriptorNotFound, "referenced %s ID %d", redact.SafeString(descType), errors.Safe(id))
+}
+
 // ErrDescriptorWrongType is returned to signal that a descriptor was found but
 // that it wasn't of the expected type.
 var ErrDescriptorWrongType = errors.New("unexpected descriptor type")

pkg/sql/catalog/internal/validate/validate.go

@@ -294,7 +294,7 @@ var _ catalog.ValidationDescGetter = (*validationDescGetterImpl)(nil)
 func (vdg *validationDescGetterImpl) GetDescriptor(id descpb.ID) (catalog.Descriptor, error) {
 	desc, found := vdg.descriptors[id]
 	if !found || desc == nil {
-		return nil, catalog.WrapDescRefErr(id, catalog.ErrReferencedDescriptorNotFound)
+		return nil, catalog.NewReferencedDescriptorNotFoundError("object", id)
 	}
 	return desc, nil
 }
@@ -305,7 +305,7 @@ func (vdg *validationDescGetterImpl) GetDatabaseDescriptor(
 ) (catalog.DatabaseDescriptor, error) {
 	desc, found := vdg.descriptors[id]
 	if !found || desc == nil {
-		return nil, catalog.WrapDatabaseDescRefErr(id, catalog.ErrReferencedDescriptorNotFound)
+		return nil, catalog.NewReferencedDescriptorNotFoundError("database", id)
 	}
 	return catalog.AsDatabaseDescriptor(desc)
 }
@@ -316,7 +316,7 @@ func (vdg *validationDescGetterImpl) GetSchemaDescriptor(
 ) (catalog.SchemaDescriptor, error) {
 	desc, found := vdg.descriptors[id]
 	if !found || desc == nil {
-		return nil, catalog.WrapSchemaDescRefErr(id, catalog.ErrReferencedDescriptorNotFound)
+		return nil, catalog.NewReferencedDescriptorNotFoundError("schema", id)
 	}
 	return catalog.AsSchemaDescriptor(desc)
 }
@@ -327,7 +327,7 @@ func (vdg *validationDescGetterImpl) GetTableDescriptor(
 ) (catalog.TableDescriptor, error) {
 	desc, found := vdg.descriptors[id]
 	if !found || desc == nil {
-		return nil, catalog.WrapTableDescRefErr(id, catalog.ErrReferencedDescriptorNotFound)
+		return nil, catalog.NewReferencedDescriptorNotFoundError("table", id)
 	}
 	return catalog.AsTableDescriptor(desc)
 }
@@ -338,7 +338,7 @@ func (vdg *validationDescGetterImpl) GetTypeDescriptor(
 ) (catalog.TypeDescriptor, error) {
 	desc, found := vdg.descriptors[id]
 	if !found || desc == nil {
-		return nil, catalog.WrapTypeDescRefErr(id, catalog.ErrReferencedDescriptorNotFound)
+		return nil, catalog.NewReferencedDescriptorNotFoundError("type", id)
 	}
 	descriptor, err := catalog.AsTypeDescriptor(desc)
 	if err != nil {
@@ -352,7 +352,7 @@ func (vdg *validationDescGetterImpl) GetFunctionDescriptor(
 ) (catalog.FunctionDescriptor, error) {
 	desc, found := vdg.descriptors[id]
 	if !found || desc == nil {
-		return nil, catalog.WrapFunctionDescRefErr(id, catalog.ErrReferencedDescriptorNotFound)
+		return nil, catalog.NewReferencedDescriptorNotFoundError("function", id)
 	}
 	return catalog.AsFunctionDescriptor(desc)
 }

pkg/sql/catalog/nstree/catalog.go

@@ -283,7 +283,7 @@ func (c Catalog) ValidateNamespaceEntry(key catalog.NameKey) error {
 	// Compare the namespace entry with the referenced descriptor.
 	desc := c.LookupDescriptor(ne.GetID())
 	if desc == nil {
-		return catalog.ErrReferencedDescriptorNotFound
+		return catalog.NewReferencedDescriptorNotFoundError("schema", ne.GetID())
 	}
 	if desc.Dropped() {
 		return catalog.ErrDescriptorDropped