chore: Add ShowByID filtering generation

pkg/sdk/poc/generator/interface.go

@@ -1,5 +1,7 @@
 package generator
 
+import "strings"
+
 // Interface groups operations for particular object or objects family (e.g. DATABASE ROLE)
 type Interface struct {
 	// Name is the interface's name, e.g. "DatabaseRoles"
@@ -25,3 +27,8 @@ func NewInterface(name string, nameSingular string, identifierKind string, opera
 func (i *Interface) NameLowerCased() string {
 	return startingWithLowerCase(i.Name)
 }
+
+// ObjectIdentifierKind returns the level of the object identifier (e.g. for DatabaseObjectIdentifier, it returns "Database")
+func (i *Interface) ObjectIdentifierKind() string {
+	return strings.Replace(i.IdentifierKind, "ObjectIdentifier", "", 1)
+}

pkg/sdk/poc/generator/operation.go

@@ -38,6 +38,8 @@ type Operation struct {
 	DescribeKind *DescriptionMappingKind
 	// DescribeMapping is a definition of mapping needed by Operation kind of OperationKindDescribe
 	DescribeMapping *Mapping
+	// ShowByIDFiltering defines a kind of filterings performed in ShowByID operation
+	ShowByIDFiltering []ShowByIDFiltering
 }
 
 type Mapping struct {
@@ -85,11 +87,11 @@ func addDescriptionMapping(op *Operation, from, to *Field) {
 	op.DescribeMapping = newMapping("convert", from, to)
 }
 
-func (i *Interface) newNoSqlOperation(kind string) *Interface {
+func (i *Interface) newNoSqlOperation(kind string) *Operation {
 	operation := newOperation(kind, "placeholder").
 		withOptionsStruct(nil)
 	i.Operations = append(i.Operations, operation)
-	return i
+	return operation
 }
 
 func (i *Interface) newSimpleOperation(kind string, doc string, queryStruct *QueryStruct, helperStructs ...IntoField) *Interface {
@@ -160,8 +162,11 @@ func (i *Interface) ShowOperation(doc string, dbRepresentation *dbStruct, resour
 	return i
 }
 
-func (i *Interface) ShowByIdOperation() *Interface {
-	return i.newNoSqlOperation(string(OperationKindShowByID))
+func (i *Interface) ShowByIdOperation(filtering ...ShowByIDFilteringKind) *Interface {
+	op := i.newNoSqlOperation(string(OperationKindShowByID))
+	op.ObjectInterface = i
+	op.withFiltering(filtering...)
+	return i
 }
 
 func (i *Interface) DescribeOperation(describeKind DescriptionMappingKind, doc string, dbRepresentation *dbStruct, resourceRepresentation *plainStruct, queryStruct *QueryStruct) *Interface {

pkg/sdk/poc/generator/show_by_id_filtering.go

@@ -0,0 +1,81 @@
+package generator
+
+import (
+	"fmt"
+	"log"
+)
+
+type ShowByIDFilteringKind uint
+
+const (
+	// Enables filtering with: Like
+	ShowByIDLikeFiltering ShowByIDFilteringKind = iota
+	// Enables filtering with: In
+	// Based on the identifier Kind
+	ShowByIDInFiltering
+	// Enables filtering with: In
+	// Based on the identifier Kind
+	ShowByIDExtendedInFiltering
+	// Enables filtering with: Limit
+	ShowByIDLimitFiltering
+)
+
+type ShowByIDFiltering interface {
+	WithFiltering() string
+}
+
+type showByIDFilter struct {
+	Name string
+	Kind string
+	Args string
+}
+
+func (s *showByIDFilter) WithFiltering() string {
+	return fmt.Sprintf("With%s(%s{%s})", s.Name, s.Kind, s.Args)
+}
+
+var filteringMapping = map[ShowByIDFilteringKind]func(string) ShowByIDFiltering{
+	ShowByIDLikeFiltering:       newShowByIDLikeFiltering,
+	ShowByIDInFiltering:         newShowByIDInFiltering,
+	ShowByIDExtendedInFiltering: newShowByIDExtendedInFiltering,
+	ShowByIDLimitFiltering:      newShowByIDLimitFiltering,
+}
+
+func newShowByIDFiltering(name, kind, args string, identifierKind *string) ShowByIDFiltering {
+	filter := &showByIDFilter{
+		Name: name,
+		Kind: kind,
+		Args: args,
+	}
+	if identifierKind != nil {
+		filter.Args = fmt.Sprintf(args, *identifierKind)
+	}
+	return filter
+}
+
+func newShowByIDLikeFiltering(string) ShowByIDFiltering {
+	return newShowByIDFiltering("Like", "Like", "Pattern: String(id.Name())", nil)
+}
+
+func newShowByIDInFiltering(identifierKind string) ShowByIDFiltering {
+	return newShowByIDFiltering("In", "In", "%[1]v: id.%[1]vId()", &identifierKind)
+}
+
+func newShowByIDExtendedInFiltering(identifierKind string) ShowByIDFiltering {
+	return newShowByIDFiltering("In", "In", "In: In{%[1]v: id.%[1]vId()}", &identifierKind)
+}
+
+func newShowByIDLimitFiltering(string) ShowByIDFiltering {
+	return newShowByIDFiltering("Limit", "LimitFrom", "Rows: Int(1)", nil)
+}
+
+func (s *Operation) withFiltering(filtering ...ShowByIDFilteringKind) *Operation {
+	for _, filteringKind := range filtering {
+		if filter, ok := filteringMapping[filteringKind]; ok {
+			s.ShowByIDFiltering = append(s.ShowByIDFiltering, filter(s.ObjectInterface.ObjectIdentifierKind()))
+		} else {
+			log.Println("No showByID filtering found for kind:", filteringKind)
+		}
+	}
+	return s
+}

pkg/sdk/poc/generator/templates/sub_templates/implementation_functions.tmpl

@@ -1,6 +1,7 @@
 {{- /*gotype: github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/sdk/poc/generator.Interface*/ -}}
 
 {{ $impl := .NameLowerCased }}
+
 {{ range .Operations }}
     {{ if and (eq .Name "Show") .ShowMapping }}
         func (v *{{ $impl }}) Show(ctx context.Context, request *{{ .OptsField.DtoDecl }}) ([]{{ .ShowMapping.To.Name }}, error) {
@@ -13,9 +14,17 @@
         return resultList, nil
         }
     {{ else if eq .Name "ShowByID" }}
+        {{ $idkind := .ObjectInterface.ObjectIdentifierKind }}
         func (v *{{ $impl }}) ShowByID(ctx context.Context, id {{ .ObjectInterface.IdentifierKind }}) (*{{ .ObjectInterface.NameSingular }}, error) {
-        // TODO: adjust request if e.g. LIKE is supported for the resource
-        {{ $impl }}, err := v.Show(ctx, NewShow{{ .ObjectInterface.NameSingular }}Request())
+            request := NewShow{{ .ObjectInterface.NameSingular }}Request()
+            {{- if not .ShowByIDFiltering }}
+                // TODO: adjust request with resource supported filtering e.g. for LIKE use 'ShowByIDLikeFiltering' in 'ShowByIdOperation()' inside the definition file.
+            {{ else }}
+                {{- range .ShowByIDFiltering }}.
+                    {{ .WithFiltering }}
+                {{- end }}
+            {{- end }}
+        {{ $impl }}, err := v.Show(ctx, request)
         if err != nil {
         return nil, err
         }

pkg/sdk/secrets_def.go

@@ -241,15 +241,17 @@ var SecretsDef = g.NewInterface(
 		SQL("SECRETS").
 		OptionalLike().
 		OptionalExtendedIn(),
-).ShowByIdOperation().
-	DescribeOperation(
-		g.DescriptionMappingKindSingleValue,
-		"https://docs.snowflake.com/en/sql-reference/sql/desc-secret",
-		secretDetailsDbRow,
-		secretDetails,
-		g.NewQueryStruct("DescribeSecret").
-			Describe().
-			SQL("SECRET").
-			Name().
-			WithValidation(g.ValidIdentifier, "name"),
-	)
+).DescribeOperation(
+	g.DescriptionMappingKindSingleValue,
+	"https://docs.snowflake.com/en/sql-reference/sql/desc-secret",
+	secretDetailsDbRow,
+	secretDetails,
+	g.NewQueryStruct("DescribeSecret").
+		Describe().
+		SQL("SECRET").
+		Name().
+		WithValidation(g.ValidIdentifier, "name"),
+).ShowByIdOperation(
+	g.ShowByIDLikeFiltering,
+	g.ShowByIDExtendedInFiltering,
+)

pkg/sdk/secrets_gen.go

@@ -14,8 +14,8 @@ type Secrets interface {
 	Alter(ctx context.Context, request *AlterSecretRequest) error
 	Drop(ctx context.Context, request *DropSecretRequest) error
 	Show(ctx context.Context, request *ShowSecretRequest) ([]Secret, error)
-	ShowByID(ctx context.Context, id SchemaObjectIdentifier) (*Secret, error)
 	Describe(ctx context.Context, id SchemaObjectIdentifier) (*SecretDetails, error)
+	ShowByID(ctx context.Context, id SchemaObjectIdentifier) (*Secret, error)
 }
 
 // CreateWithOAuthClientCredentialsFlowSecretOptions is based on https://docs.snowflake.com/en/sql-reference/sql/create-secret.

pkg/sdk/secrets_impl_gen.go

@@ -52,15 +52,6 @@ func (v *secrets) Show(ctx context.Context, request *ShowSecretRequest) ([]Secre
 	return resultList, nil
 }
 
-func (v *secrets) ShowByID(ctx context.Context, id SchemaObjectIdentifier) (*Secret, error) {
-	request := NewShowSecretRequest().WithIn(ExtendedIn{In: In{Schema: id.SchemaId()}}).WithLike(Like{String(id.Name())})
-	secrets, err := v.Show(ctx, request)
-	if err != nil {
-		return nil, err
-	}
-	return collections.FindFirst(secrets, func(r Secret) bool { return r.Name == id.Name() })
-}
-
 func (v *secrets) Describe(ctx context.Context, id SchemaObjectIdentifier) (*SecretDetails, error) {
 	opts := &DescribeSecretOptions{
 		name: id,
@@ -72,14 +63,24 @@ func (v *secrets) Describe(ctx context.Context, id SchemaObjectIdentifier) (*Sec
 	return result.convert(), nil
 }
 
+func (v *secrets) ShowByID(ctx context.Context, id SchemaObjectIdentifier) (*Secret, error) {
+	request := NewShowSecretRequest().
+		WithLike(Like{Pattern: String(id.Name())}).
+		WithIn(ExtendedIn{In: In{Schema: id.SchemaId()}})
+	secrets, err := v.Show(ctx, request)
+	if err != nil {
+		return nil, err
+	}
+	return collections.FindFirst(secrets, func(r Secret) bool { return r.Name == id.Name() })
+}
+
 func (r *CreateWithOAuthClientCredentialsFlowSecretRequest) toOpts() *CreateWithOAuthClientCredentialsFlowSecretOptions {
 	opts := &CreateWithOAuthClientCredentialsFlowSecretOptions{
 		OrReplace:      r.OrReplace,
 		IfNotExists:    r.IfNotExists,
 		name:           r.name,
 		ApiIntegration: r.ApiIntegration,
-
-		Comment: r.Comment,
+		Comment:        r.Comment,
 	}
 
 	if r.OauthScopes != nil {

pkg/sdk/streamlits_def.go

@@ -103,7 +103,10 @@ var StreamlitsDef = g.NewInterface(
 		OptionalLike().
 		OptionalIn().
 		OptionalLimit(),
-).ShowByIdOperation().DescribeOperation(
+).ShowByIdOperation(
+	g.ShowByIDLikeFiltering,
+	g.ShowByIDInFiltering,
+).DescribeOperation(
 	g.DescriptionMappingKindSingleValue,
 	"https://docs.snowflake.com/en/sql-reference/sql/desc-streamlit",
 	g.DbStruct("streamlitsDetailRow").

pkg/sdk/streamlits_impl_gen.go

@@ -38,7 +38,9 @@ func (v *streamlits) Show(ctx context.Context, request *ShowStreamlitRequest) ([
 }
 
 func (v *streamlits) ShowByID(ctx context.Context, id SchemaObjectIdentifier) (*Streamlit, error) {
-	request := NewShowStreamlitRequest().WithIn(In{Schema: id.SchemaId()}).WithLike(Like{String(id.Name())})
+	request := NewShowStreamlitRequest().
+		WithLike(Like{Pattern: String(id.Name())}).
+		WithIn(In{Schema: id.SchemaId()})
 	streamlits, err := v.Show(ctx, request)
 	if err != nil {
 		return nil, err
@@ -92,9 +94,8 @@ func (r *AlterStreamlitRequest) toOpts() *AlterStreamlitOptions {
 			RootLocation:   r.Set.RootLocation,
 			MainFile:       r.Set.MainFile,
 			QueryWarehouse: r.Set.QueryWarehouse,
-
-			Comment: r.Set.Comment,
-			Title:   r.Set.Title,
+			Comment:        r.Set.Comment,
+			Title:          r.Set.Title,
 		}
 
 		if r.Set.ExternalAccessIntegrations != nil {