chore: optimize the error message and example (#119)

ecmadao · web-flow · commit 0e7684d924ab · 2025-06-25T16:16:47.000+08:00
diff --git a/docs/data-sources/instance.md b/docs/data-sources/instance.md
@@ -53,6 +53,7 @@ Read-Only:
 - `ssl_cert` (String)
 - `ssl_key` (String)
 - `type` (String)
+- `use_ssl` (Boolean)
 - `username` (String)
 
 <a id="nestedobjatt--data_sources--external_secret"></a>
diff --git a/docs/data-sources/instance_list.md b/docs/data-sources/instance_list.md
@@ -62,6 +62,7 @@ Read-Only:
 - `ssl_cert` (String)
 - `ssl_key` (String)
 - `type` (String)
+- `use_ssl` (Boolean)
 - `username` (String)
 
 <a id="nestedobjatt--instances--data_sources--external_secret"></a>
diff --git a/docs/resources/instance.md b/docs/resources/instance.md
@@ -56,6 +56,7 @@ Optional:
 - `ssl_ca` (String, Sensitive) The CA certificate. Optional, you can set this if the engine type is MYSQL, POSTGRES, TIDB or CLICKHOUSE.
 - `ssl_cert` (String, Sensitive) The client certificate. Optional, you can set this if the engine type is MYSQL, POSTGRES, TIDB or CLICKHOUSE.
 - `ssl_key` (String, Sensitive) The client key. Optional, you can set this if the engine type is MYSQL, POSTGRES, TIDB or CLICKHOUSE.
+- `use_ssl` (Boolean) Enable SSL connection. Required to use SSL certificates.
 - `username` (String) The connection user name used by Bytebase to perform DDL and DML operations.
 
 <a id="nestedblock--data_sources--external_secret"></a>
diff --git a/examples/database/main.tf b/examples/database/main.tf
@@ -2,7 +2,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.7.1"
+      version = "3.7.2"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/database_group/main.tf b/examples/database_group/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.7.1"
+      version = "3.7.2"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/environments/README.md b/examples/environments/README.md
@@ -8,6 +8,6 @@ You should replace the provider initial variables with your own and exec the [se
 
 ```terraform
 data "bytebase_setting" "environments" {
-  name = "ENVIRONMENT"
+  name = "settings/ENVIRONMENT"
 }
 ```
diff --git a/examples/environments/main.tf b/examples/environments/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.7.1"
+      version = "3.7.2"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
@@ -19,7 +19,7 @@ provider "bytebase" {
 
 # List all environment
 data "bytebase_setting" "environments" {
-  name = "ENVIRONMENT"
+  name = "settings/ENVIRONMENT"
 }
 
 output "all_environments" {
diff --git a/examples/groups/main.tf b/examples/groups/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.7.1"
+      version = "3.7.2"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/iamPolicy/main.tf b/examples/iamPolicy/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.7.1"
+      version = "3.7.2"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/instances/main.tf b/examples/instances/main.tf
@@ -2,7 +2,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.7.1"
+      version = "3.7.2"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/policies/main.tf b/examples/policies/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.7.1"
+      version = "3.7.2"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/projects/main.tf b/examples/projects/main.tf
@@ -2,7 +2,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.7.1"
+      version = "3.7.2"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/risk/main.tf b/examples/risk/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.7.1"
+      version = "3.7.2"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/roles/main.tf b/examples/roles/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.7.1"
+      version = "3.7.2"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/settings/main.tf b/examples/settings/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.7.1"
+      version = "3.7.2"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/setup/environment.tf b/examples/setup/environment.tf
@@ -1,5 +1,6 @@
 resource "bytebase_setting" "environments" {
-  name = "ENVIRONMENT"
+  name = "settings/ENVIRONMENT"
+
   environment_setting {
     environment {
       id        = local.environment_id_prod
diff --git a/examples/setup/main.tf b/examples/setup/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.7.1"
+      version = "3.7.2"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/sql_review/main.tf b/examples/sql_review/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.7.1"
+      version = "3.7.2"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/users/main.tf b/examples/users/main.tf
@@ -2,7 +2,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.7.1"
+      version = "3.7.2"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/provider/data_source_database_group.go b/provider/data_source_database_group.go
@@ -3,7 +3,6 @@ package provider
 import (
 	"context"
 	"fmt"
-	"regexp"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -29,7 +28,7 @@ func dataSourceDatabaseGroup() *schema.Resource {
 				Type:     schema.TypeString,
 				Required: true,
 				ValidateDiagFunc: internal.ResourceNameValidation(
-					regexp.MustCompile(fmt.Sprintf("^%s%s$", internal.ProjectNamePrefix, internal.ResourceIDPattern)),
+					fmt.Sprintf("^%s%s$", internal.ProjectNamePrefix, internal.ResourceIDPattern),
 				),
 				Description: "The project fullname in projects/{id} format.",
 			},
diff --git a/provider/data_source_database_group_list.go b/provider/data_source_database_group_list.go
@@ -3,7 +3,6 @@ package provider
 import (
 	"context"
 	"fmt"
-	"regexp"
 	"strconv"
 	"time"
 
@@ -23,7 +22,7 @@ func dataSourceDatabaseGroupList() *schema.Resource {
 				Type:     schema.TypeString,
 				Required: true,
 				ValidateDiagFunc: internal.ResourceNameValidation(
-					regexp.MustCompile(fmt.Sprintf("^%s%s$", internal.ProjectNamePrefix, internal.ResourceIDPattern)),
+					fmt.Sprintf("^%s%s$", internal.ProjectNamePrefix, internal.ResourceIDPattern),
 				),
 				Description: "The project fullname in projects/{id} format.",
 			},
diff --git a/provider/data_source_database_list.go b/provider/data_source_database_list.go
@@ -3,7 +3,6 @@ package provider
 import (
 	"context"
 	"fmt"
-	"regexp"
 	"strconv"
 	"time"
 
@@ -25,9 +24,9 @@ func dataSourceDatabaseList() *schema.Resource {
 				Type:     schema.TypeString,
 				Required: true,
 				ValidateDiagFunc: internal.ResourceNameValidation(
-					regexp.MustCompile("^workspaces/-$"),
-					regexp.MustCompile(fmt.Sprintf("^%s%s$", internal.InstanceNamePrefix, internal.ResourceIDPattern)),
-					regexp.MustCompile(fmt.Sprintf("^%s%s$", internal.ProjectNamePrefix, internal.ResourceIDPattern)),
+					fmt.Sprintf("^%s$", internal.WorkspaceName),
+					fmt.Sprintf("^%s%s$", internal.InstanceNamePrefix, internal.ResourceIDPattern),
+					fmt.Sprintf("^%s%s$", internal.ProjectNamePrefix, internal.ResourceIDPattern),
 				),
 			},
 			"query": {
@@ -41,22 +40,28 @@ func dataSourceDatabaseList() *schema.Resource {
 				Description: "If not include unassigned databases in the response.",
 			},
 			"environment": {
-				Type:             schema.TypeString,
-				Optional:         true,
-				Description:      "The environment full name. Filter databases by environment.",
-				ValidateDiagFunc: internal.ResourceNameValidation(regexp.MustCompile(fmt.Sprintf("^%s%s$", internal.EnvironmentNamePrefix, internal.ResourceIDPattern))),
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: "The environment full name. Filter databases by environment.",
+				ValidateDiagFunc: internal.ResourceNameValidation(
+					fmt.Sprintf("^%s%s$", internal.EnvironmentNamePrefix, internal.ResourceIDPattern),
+				),
 			},
 			"project": {
-				Type:             schema.TypeString,
-				Optional:         true,
-				Description:      "The project full name. Filter databases by project.",
-				ValidateDiagFunc: internal.ResourceNameValidation(regexp.MustCompile(fmt.Sprintf("^%s%s$", internal.ProjectNamePrefix, internal.ResourceIDPattern))),
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: "The project full name. Filter databases by project.",
+				ValidateDiagFunc: internal.ResourceNameValidation(
+					fmt.Sprintf("^%s%s$", internal.ProjectNamePrefix, internal.ResourceIDPattern),
+				),
 			},
 			"instance": {
-				Type:             schema.TypeString,
-				Optional:         true,
-				Description:      "The instance full name. Filter databases by instance.",
-				ValidateDiagFunc: internal.ResourceNameValidation(regexp.MustCompile(fmt.Sprintf("^%s%s$", internal.InstanceNamePrefix, internal.ResourceIDPattern))),
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: "The instance full name. Filter databases by instance.",
+				ValidateDiagFunc: internal.ResourceNameValidation(
+					fmt.Sprintf("^%s%s$", internal.InstanceNamePrefix, internal.ResourceIDPattern),
+				),
 			},
 			"engines": {
 				Type:     schema.TypeSet,
diff --git a/provider/data_source_group.go b/provider/data_source_group.go
@@ -4,7 +4,6 @@ import (
 	"bytes"
 	"context"
 	"fmt"
-	"regexp"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -24,7 +23,7 @@ func dataSourceGroup() *schema.Resource {
 				Type:     schema.TypeString,
 				Required: true,
 				ValidateDiagFunc: internal.ResourceNameValidation(
-					regexp.MustCompile(fmt.Sprintf("^%s", internal.GroupNamePrefix)),
+					fmt.Sprintf("^%s", internal.GroupNamePrefix),
 				),
 				Description: "The group name in groups/{email} format.",
 			},
diff --git a/provider/data_source_iam_policy.go b/provider/data_source_iam_policy.go
@@ -4,7 +4,6 @@ import (
 	"bytes"
 	"context"
 	"fmt"
-	"regexp"
 	"strconv"
 	"strings"
 
@@ -28,9 +27,9 @@ func dataSourceIAMPolicy() *schema.Resource {
 				Required: true,
 				ValidateDiagFunc: internal.ResourceNameValidation(
 					// workspace policy
-					regexp.MustCompile("^workspaces/-$"),
+					fmt.Sprintf("^%s$", internal.WorkspaceName),
 					// project policy
-					regexp.MustCompile(fmt.Sprintf("^%s%s$", internal.ProjectNamePrefix, internal.ResourceIDPattern)),
+					fmt.Sprintf("^%s%s$", internal.ProjectNamePrefix, internal.ResourceIDPattern),
 				),
 				Description: `The IAM policy parent name for the policy, support "projects/{resource id}" or "workspaces/-"`,
 			},
diff --git a/provider/data_source_instance_list.go b/provider/data_source_instance_list.go
@@ -3,7 +3,6 @@ package provider
 import (
 	"context"
 	"fmt"
-	"regexp"
 	"strconv"
 	"time"
 
@@ -28,16 +27,20 @@ func dataSourceInstanceList() *schema.Resource {
 				Description: "Filter instances by name or resource id with wildcard",
 			},
 			"environment": {
-				Type:             schema.TypeString,
-				Optional:         true,
-				Description:      "The environment full name. Filter instances by environment.",
-				ValidateDiagFunc: internal.ResourceNameValidation(regexp.MustCompile(fmt.Sprintf("^%s%s$", internal.EnvironmentNamePrefix, internal.ResourceIDPattern))),
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: "The environment full name. Filter instances by environment.",
+				ValidateDiagFunc: internal.ResourceNameValidation(
+					fmt.Sprintf("^%s%s$", internal.EnvironmentNamePrefix, internal.ResourceIDPattern),
+				),
 			},
 			"project": {
-				Type:             schema.TypeString,
-				Optional:         true,
-				Description:      "The project full name. Filter instances by project.",
-				ValidateDiagFunc: internal.ResourceNameValidation(regexp.MustCompile(fmt.Sprintf("^%s%s$", internal.ProjectNamePrefix, internal.ResourceIDPattern))),
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: "The project full name. Filter instances by project.",
+				ValidateDiagFunc: internal.ResourceNameValidation(
+					fmt.Sprintf("^%s%s$", internal.ProjectNamePrefix, internal.ResourceIDPattern),
+				),
 			},
 			"host": {
 				Type:        schema.TypeString,
diff --git a/provider/data_source_policy.go b/provider/data_source_policy.go
@@ -4,7 +4,6 @@ import (
 	"bytes"
 	"context"
 	"fmt"
-	"regexp"
 	"strings"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
@@ -29,15 +28,15 @@ func dataSourcePolicy() *schema.Resource {
 				Default:  "",
 				ValidateDiagFunc: internal.ResourceNameValidation(
 					// workspace policy
-					regexp.MustCompile(fmt.Sprintf("^%s$", internal.WorkspaceName)),
+					fmt.Sprintf("^%s$", internal.WorkspaceName),
 					// environment policy
-					regexp.MustCompile(fmt.Sprintf("^%s%s$", internal.EnvironmentNamePrefix, internal.ResourceIDPattern)),
+					fmt.Sprintf("^%s%s$", internal.EnvironmentNamePrefix, internal.ResourceIDPattern),
 					// instance policy
-					regexp.MustCompile(fmt.Sprintf("^%s%s$", internal.InstanceNamePrefix, internal.ResourceIDPattern)),
+					fmt.Sprintf("^%s%s$", internal.InstanceNamePrefix, internal.ResourceIDPattern),
 					// project policy
-					regexp.MustCompile(fmt.Sprintf("^%s%s$", internal.ProjectNamePrefix, internal.ResourceIDPattern)),
+					fmt.Sprintf("^%s%s$", internal.ProjectNamePrefix, internal.ResourceIDPattern),
 					// database policy
-					regexp.MustCompile(fmt.Sprintf("^%s%s/%s%s$", internal.InstanceNamePrefix, internal.ResourceIDPattern, internal.DatabaseIDPrefix, internal.ResourceIDPattern)),
+					fmt.Sprintf("^%s%s/%s%s$", internal.InstanceNamePrefix, internal.ResourceIDPattern, internal.DatabaseIDPrefix, internal.ResourceIDPattern),
 				),
 				Description: "The policy parent name for the policy, support projects/{resource id}, environments/{resource id}, instances/{resource id}, or instances/{resource id}/databases/{database name}",
 			},
diff --git a/provider/data_source_policy_list.go b/provider/data_source_policy_list.go
diff --git a/provider/data_source_setting.go b/provider/data_source_setting.go
diff --git a/provider/data_source_user.go b/provider/data_source_user.go
diff --git a/provider/data_source_user_list.go b/provider/data_source_user_list.go
diff --git a/provider/internal/utils.go b/provider/internal/utils.go
diff --git a/provider/resource_database_group.go b/provider/resource_database_group.go
diff --git a/provider/resource_group.go b/provider/resource_group.go
diff --git a/provider/resource_iam_policy.go b/provider/resource_iam_policy.go
diff --git a/provider/resource_instance.go b/provider/resource_instance.go
diff --git a/provider/resource_policy.go b/provider/resource_policy.go
diff --git a/provider/resource_setting.go b/provider/resource_setting.go

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`terraform {`
`3`	`3`	`required_providers {`
`4`	`4`	`bytebase = {`
`5`		`- version = "3.7.1"`
	`5`	`+ version = "3.7.2"`
`6`	`6`	`# For local development, please use "terraform.local/bytebase/bytebase" instead`
`7`	`7`	`source = "registry.terraform.io/bytebase/bytebase"`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`terraform {`
`2`	`2`	`required_providers {`
`3`	`3`	`bytebase = {`
`4`		`- version = "3.7.1"`
	`4`	`+ version = "3.7.2"`
`5`	`5`	`# For local development, please use "terraform.local/bytebase/bytebase" instead`
`6`	`6`	`source = "registry.terraform.io/bytebase/bytebase"`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,6 @@ You should replace the provider initial variables with your own and exec the [se`
`8`	`8`
`9`	`9`	```terraform
`10`	`10`	`data "bytebase_setting" "environments" {`
`11`		`- name = "ENVIRONMENT"`
	`11`	`+ name = "settings/ENVIRONMENT"`
`12`	`12`	`}`
`13`	`13`	```