chore: add databases for instance (#88)

ecmadao · web-flow · commit b87b6bfc292f · 2025-02-06T15:09:22.000+08:00
* chore: use set for unordered collection

* chore: update doc

* fix: list all databases in the project

* chore: update

* fix: lint

* chore: add databases for instance
diff --git a/docs/data-sources/instance.md b/docs/data-sources/instance.md
@@ -22,6 +22,7 @@ The instance data source.
 ### Read-Only
 
 - `data_sources` (Set of Object) (see [below for nested schema](#nestedatt--data_sources))
+- `databases` (Set of Object) The databases in the resource. (see [below for nested schema](#nestedatt--databases))
 - `engine` (String) The instance engine. Support MYSQL, POSTGRES, TIDB, SNOWFLAKE, CLICKHOUSE, MONGODB, SQLITE, REDIS, ORACLE, SPANNER, MSSQL, REDSHIFT, MARIADB, OCEANBASE.
 - `engine_version` (String) The engine version.
 - `environment` (String) The environment name for your instance in "environments/{resource id}" format.
@@ -49,3 +50,17 @@ Read-Only:
 - `username` (String)
 
 
+<a id="nestedatt--databases"></a>
+### Nested Schema for `databases`
+
+Read-Only:
+
+- `environment` (String)
+- `labels` (Map of String)
+- `name` (String)
+- `project` (String)
+- `schema_version` (String)
+- `successful_sync_time` (String)
+- `sync_state` (String)
+
+
diff --git a/docs/data-sources/instance_list.md b/docs/data-sources/instance_list.md
@@ -29,7 +29,8 @@ The instance data source list.
 
 Read-Only:
 
-- `data_sources` (List of Object) (see [below for nested schema](#nestedobjatt--instances--data_sources))
+- `data_sources` (Set of Object) (see [below for nested schema](#nestedobjatt--instances--data_sources))
+- `databases` (Set of Object) (see [below for nested schema](#nestedobjatt--instances--databases))
 - `engine` (String)
 - `engine_version` (String)
 - `environment` (String)
@@ -57,3 +58,17 @@ Read-Only:
 - `username` (String)
 
 
+<a id="nestedobjatt--instances--databases"></a>
+### Nested Schema for `instances.databases`
+
+Read-Only:
+
+- `environment` (String)
+- `labels` (Map of String)
+- `name` (String)
+- `project` (String)
+- `schema_version` (String)
+- `successful_sync_time` (String)
+- `sync_state` (String)
+
+
diff --git a/docs/data-sources/project.md b/docs/data-sources/project.md
@@ -24,7 +24,7 @@ The project data source.
 - `allow_modify_statement` (Boolean) Allow modifying statement after issue is created.
 - `auto_enable_backup` (Boolean) Whether to automatically enable backup.
 - `auto_resolve_issue` (Boolean) Enable auto resolve issue.
-- `databases` (Set of Object) The databases in the project. (see [below for nested schema](#nestedatt--databases))
+- `databases` (Set of Object) The databases in the resource. (see [below for nested schema](#nestedatt--databases))
 - `enforce_issue_title` (Boolean) Enforce issue title created by user instead of generated by Bytebase.
 - `id` (String) The ID of this resource.
 - `key` (String) The project key.
@@ -43,6 +43,7 @@ Read-Only:
 - `environment` (String)
 - `labels` (Map of String)
 - `name` (String)
+- `project` (String)
 - `schema_version` (String)
 - `successful_sync_time` (String)
 - `sync_state` (String)
diff --git a/docs/data-sources/project_list.md b/docs/data-sources/project_list.md
@@ -51,6 +51,7 @@ Read-Only:
 - `environment` (String)
 - `labels` (Map of String)
 - `name` (String)
+- `project` (String)
 - `schema_version` (String)
 - `successful_sync_time` (String)
 - `sync_state` (String)
diff --git a/docs/resources/instance.md b/docs/resources/instance.md
@@ -31,6 +31,7 @@ The instance resource.
 
 ### Read-Only
 
+- `databases` (Set of Object) The databases in the resource. (see [below for nested schema](#nestedatt--databases))
 - `engine_version` (String) The engine version.
 - `id` (String) The ID of this resource.
 - `name` (String) The instance full name in instances/{resource id} format.
@@ -55,3 +56,17 @@ Optional:
 - `username` (String) The connection user name used by Bytebase to perform DDL and DML operations.
 
 
+<a id="nestedatt--databases"></a>
+### Nested Schema for `databases`
+
+Read-Only:
+
+- `environment` (String)
+- `labels` (Map of String)
+- `name` (String)
+- `project` (String)
+- `schema_version` (String)
+- `successful_sync_time` (String)
+- `sync_state` (String)
+
+
diff --git a/docs/resources/project.md b/docs/resources/project.md
@@ -26,7 +26,7 @@ The project resource.
 - `allow_modify_statement` (Boolean) Allow modifying statement after issue is created.
 - `auto_enable_backup` (Boolean) Whether to automatically enable backup.
 - `auto_resolve_issue` (Boolean) Enable auto resolve issue.
-- `databases` (Block Set) The databases in the project. (see [below for nested schema](#nestedblock--databases))
+- `databases` (Block Set) The databases in the resource. (see [below for nested schema](#nestedblock--databases))
 - `enforce_issue_title` (Boolean) Enforce issue title created by user instead of generated by Bytebase.
 - `members` (Block Set) The members in the project. (see [below for nested schema](#nestedblock--members))
 - `postgres_database_tenant_mode` (Boolean) Whether to enable the database tenant mode for PostgreSQL. If enabled, the issue will be created with the pre-appended "set role <db_owner>" statement.
@@ -49,6 +49,7 @@ Optional:
 Read-Only:
 
 - `environment` (String) The database environment.
+- `project` (String) The project full name for the database.
 - `schema_version` (String) The version of database schema.
 - `successful_sync_time` (String) The latest synchronization time.
 - `sync_state` (String) The existence of a database on latest sync.
diff --git a/provider/data_source_instance.go b/provider/data_source_instance.go
@@ -125,6 +125,7 @@ func dataSourceInstance() *schema.Resource {
 				},
 				Set: dataSourceHash,
 			},
+			"databases": getDatabasesSchema(true),
 		},
 	}
 }
@@ -140,5 +141,5 @@ func dataSourceInstanceRead(ctx context.Context, d *schema.ResourceData, m inter
 
 	d.SetId(ins.Name)
 
-	return setInstanceMessage(d, ins)
+	return setInstanceMessage(ctx, c, d, ins)
 }
diff --git a/provider/data_source_instance_list.go b/provider/data_source_instance_list.go
@@ -74,7 +74,7 @@ func dataSourceInstanceList() *schema.Resource {
 							Description: "The maximum number of connections. The default value is 10.",
 						},
 						"data_sources": {
-							Type:     schema.TypeList,
+							Type:     schema.TypeSet,
 							Computed: true,
 							Elem: &schema.Resource{
 								Schema: map[string]*schema.Schema{
@@ -134,7 +134,9 @@ func dataSourceInstanceList() *schema.Resource {
 									},
 								},
 							},
+							Set: dataSourceHash,
 						},
+						"databases": getDatabasesSchema(true),
 					},
 				},
 			},
@@ -178,7 +180,14 @@ func dataSourceInstanceListRead(ctx context.Context, d *schema.ResourceData, m i
 		if err != nil {
 			return diag.FromErr(err)
 		}
-		ins["data_sources"] = dataSources
+		ins["data_sources"] = schema.NewSet(dataSourceHash, dataSources)
+
+		databases, err := c.ListDatabase(ctx, instanceID, "")
+		if err != nil {
+			return diag.FromErr(err)
+		}
+		databaseList := flattenDatabaseList(databases)
+		ins["databases"] = schema.NewSet(databaseHash, databaseList)
 
 		instances = append(instances, ins)
 	}
diff --git a/provider/data_source_project.go b/provider/data_source_project.go
@@ -79,18 +79,18 @@ func dataSourceProject() *schema.Resource {
 				Computed:    true,
 				Description: "Whether to enable the database tenant mode for PostgreSQL. If enabled, the issue will be created with the pre-appended \"set role <db_owner>\" statement.",
 			},
-			"databases": getProjectDatabasesSchema(true),
+			"databases": getDatabasesSchema(true),
 			"members":   getProjectMembersSchema(true),
 		},
 	}
 }
 
-func getProjectDatabasesSchema(computed bool) *schema.Schema {
+func getDatabasesSchema(computed bool) *schema.Schema {
 	return &schema.Schema{
 		Type:        schema.TypeSet,
 		Computed:    computed,
 		Optional:    !computed,
-		Description: "The databases in the project.",
+		Description: "The databases in the resource.",
 		Elem: &schema.Resource{
 			Schema: map[string]*schema.Schema{
 				"name": {
@@ -99,6 +99,11 @@ func getProjectDatabasesSchema(computed bool) *schema.Schema {
 					Optional:    !computed,
 					Description: "The database full name in instances/{instance id}/databases/{db name} format.",
 				},
+				"project": {
+					Type:        schema.TypeString,
+					Computed:    true,
+					Description: "The project full name for the database.",
+				},
 				"environment": {
 					Type:        schema.TypeString,
 					Computed:    true,
@@ -222,6 +227,7 @@ func flattenDatabaseList(databases []*v1pb.Database) []interface{} {
 	for _, database := range databases {
 		db := map[string]interface{}{}
 		db["name"] = database.Name
+		db["project"] = database.Project
 		db["environment"] = database.Environment
 		db["sync_state"] = database.SyncState.String()
 		db["successful_sync_time"] = database.SuccessfulSyncTime.AsTime().UTC().Format(time.RFC3339)
diff --git a/provider/data_source_project_list.go b/provider/data_source_project_list.go
@@ -84,7 +84,7 @@ func dataSourceProjectList() *schema.Resource {
 							Computed:    true,
 							Description: "Whether to enable the database tenant mode for PostgreSQL. If enabled, the issue will be created with the pre-appended \"set role <db_owner>\" statement.",
 						},
-						"databases": getProjectDatabasesSchema(true),
+						"databases": getDatabasesSchema(true),
 						"members":   getProjectMembersSchema(true),
 					},
 				},
@@ -130,7 +130,8 @@ func dataSourceProjectListRead(ctx context.Context, d *schema.ResourceData, m in
 			return diag.FromErr(err)
 		}
 
-		proj["databases"] = flattenDatabaseList(databases)
+		databaseList := flattenDatabaseList(databases)
+		proj["databases"] = schema.NewSet(databaseHash, databaseList)
 
 		iamPolicy, err := c.GetProjectIAMPolicy(ctx, project.Name)
 		if err != nil {
@@ -140,7 +141,7 @@ func dataSourceProjectListRead(ctx context.Context, d *schema.ResourceData, m in
 		if err != nil {
 			return diag.FromErr(err)
 		}
-		proj["members"] = memberList
+		proj["members"] = schema.NewSet(memberHash, memberList)
 
 		projects = append(projects, proj)
 	}
diff --git a/provider/resource_instance.go b/provider/resource_instance.go
@@ -180,6 +180,7 @@ func resourceInstance() *schema.Resource {
 				},
 				Set: dataSourceHash,
 			},
+			"databases": getDatabasesSchema(true),
 		},
 	}
 }
@@ -325,7 +326,7 @@ func resourceInstanceRead(ctx context.Context, d *schema.ResourceData, m interfa
 		return diag.FromErr(err)
 	}
 
-	return setInstanceMessage(d, instance)
+	return setInstanceMessage(ctx, c, d, instance)
 }
 
 func resourceInstanceUpdate(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
@@ -436,7 +437,12 @@ func resourceInstanceDelete(ctx context.Context, d *schema.ResourceData, m inter
 	return diags
 }
 
-func setInstanceMessage(d *schema.ResourceData, instance *v1pb.Instance) diag.Diagnostics {
+func setInstanceMessage(
+	ctx context.Context,
+	client api.Client,
+	d *schema.ResourceData,
+	instance *v1pb.Instance,
+) diag.Diagnostics {
 	instanceID, err := internal.GetInstanceID(instance.Name)
 	if err != nil {
 		return diag.FromErr(err)
@@ -479,6 +485,15 @@ func setInstanceMessage(d *schema.ResourceData, instance *v1pb.Instance) diag.Di
 		return diag.Errorf("cannot set data_sources for instance: %s", err.Error())
 	}
 
+	databases, err := client.ListDatabase(ctx, instanceID, "")
+	if err != nil {
+		return diag.FromErr(err)
+	}
+	databaseList := flattenDatabaseList(databases)
+	if err := d.Set("databases", schema.NewSet(databaseHash, databaseList)); err != nil {
+		return diag.Errorf("cannot set databases for instance: %s", err.Error())
+	}
+
 	return nil
 }
 
diff --git a/provider/resource_project.go b/provider/resource_project.go
@@ -98,7 +98,7 @@ func resourceProjct() *schema.Resource {
 				Default:     false,
 				Description: "Whether to enable the database tenant mode for PostgreSQL. If enabled, the issue will be created with the pre-appended \"set role <db_owner>\" statement.",
 			},
-			"databases": getProjectDatabasesSchema(false),
+			"databases": getDatabasesSchema(false),
 			"members":   getProjectMembersSchema(false),
 		},
 	}

Original file line number	Diff line number	Diff line change
`@@ -125,6 +125,7 @@ func dataSourceInstance() *schema.Resource {`
`125`	`125`	`},`
`126`	`126`	`Set: dataSourceHash,`
`127`	`127`	`},`
	`128`	`+ "databases": getDatabasesSchema(true),`
`128`	`129`	`},`
`129`	`130`	`}`
`130`	`131`	`}`
`@@ -140,5 +141,5 @@ func dataSourceInstanceRead(ctx context.Context, d *schema.ResourceData, m inter`
`140`	`141`
`141`	`142`	`d.SetId(ins.Name)`
`142`	`143`
`143`		`- return setInstanceMessage(d, ins)`
	`144`	`+ return setInstanceMessage(ctx, c, d, ins)`
`144`	`145`	`}`