chore: update instance engine types (#58)

* chore: update instance engine types

* chore: update

Author: d-bytebase

api/common.go

@@ -28,4 +28,18 @@ const (
 	EngineTypeMongoDB EngineType = "MONGODB"
 	// EngineTypeSQLite is the database type for SQLite.
 	EngineTypeSQLite EngineType = "SQLITE"
+	// EngineTypeRedis is the database type for REDIS.
+	EngineTypeRedis EngineType = "REDIS"
+	// EngineTypeOracle is the database type for ORACLE.
+	EngineTypeOracle EngineType = "ORACLE"
+	// EngineTypeSpanner is the database type for SPANNER.
+	EngineTypeSpanner EngineType = "SPANNER"
+	// EngineTypeMSSQL is the database type for MSSQL.
+	EngineTypeMSSQL EngineType = "MSSQL"
+	// EngineTypeRedshift is the database type for REDSHIFT.
+	EngineTypeRedshift EngineType = "REDSHIFT"
+	// EngineTypeMariaDB is the database type for MARIADB.
+	EngineTypeMariaDB EngineType = "MARIADB"
+	// EngineTypeOceanbase is the database type for OCEANBASE.
+	EngineTypeOceanbase EngineType = "OCEANBASE"
 )

docs/assets/overview.webp

@@ -8,37 +8,25 @@ description: |-
 
 # bytebase_database (Data Source)
 
-The database data source. You can get a single database through `bytebase_database` data source.
+The database data source.
 
-## Example Usage
 
-```terraform
-# Find a database by it's name and instance resource id.
-data "bytebase_database" "employee" {
-  name     = "employee"
-  instance = "postgres-sample"
-}
-
-output "employee_databases" {
-  value = data.bytebase_database.employee
-}
-```
-
-You can check [examples](https://github.com/bytebase/terraform-provider-bytebase/blob/main/examples/databases) for more usage examples.
 
 <!-- schema generated by tfplugindocs -->
-
 ## Schema
 
 ### Required
 
+- `instance` (String) The instance resource id for the database.
 - `name` (String) The database name.
-- `instance` (String) The instance unique resource id.
 
 ### Read-Only
 
-- `project` (String) The project unique resource id.
+- `id` (String) The ID of this resource.
 - `labels` (Map of String) The  deployment and policy control labels.
-- `sync_state` (String) The existence of a database on latest sync.
-- `successful_sync_time` (String) The latest synchronization time.
+- `project` (String) The project for a database with projects/{project} format.
 - `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.
+
+

docs/data-sources/database.md

@@ -8,46 +8,34 @@ description: |-
 
 # bytebase_database_list (Data Source)
 
-The database data source list. You can list databases through `bytebase_database_list` data source.
+The database data source list.
 
-## Example Usage
 
-```terraform
-# List all databases in all instances
-data "bytebase_database_list" "all" {
-}
-
-output "all_databases" {
-  value = data.bytebase_database_list.all
-}
-
-# List all databases with project filter
-data "bytebase_database_list" "sample" {
-  project = "project-sample"
-}
-
-output "databases_in_sample_project" {
-  value = data.bytebase_database_list.sample
-}
-```
-
-You can check [examples](https://github.com/bytebase/terraform-provider-bytebase/blob/main/examples/databases) for more usage examples.
 
 <!-- schema generated by tfplugindocs -->
-
 ## Schema
 
 ### Optional
 
-- `instance` (String) The instance unique resource id.
-- `project` (String) The project unique resource id.
+- `instance` (String) The instance resource id for the database. You can use "-" to list databases in all instances.
+- `project` (String) The project resource id for the database. You can use "-" to list databases in all projects.
 
 ### Read-Only
 
 - `databases` (List of Object) (see [below for nested schema](#nestedatt--databases))
+- `id` (String) The ID of this resource.
 
 <a id="nestedatt--databases"></a>
-
 ### Nested Schema for `databases`
 
-See [Databases Schema](https://registry.terraform.io/providers/bytebase/bytebase/latest/docs/data-sources/database#schema).
+Read-Only:
+
+- `instance` (String)
+- `labels` (Map of String)
+- `name` (String)
+- `project` (String)
+- `schema_version` (String)
+- `successful_sync_time` (String)
+- `sync_state` (String)
+
+

docs/data-sources/database_list.md

@@ -8,36 +8,22 @@ description: |-
 
 # bytebase_environment (Data Source)
 
-The environment data source. You can get a single environment through `bytebase_environment` data source.
+The environment data source.
 
-## Example Usage
 
-```terraform
-# Get environment by resource id
-data "bytebase_environment" "dev" {
-    resource_id = "dev"
-}
-
-output "env" {
-  value = data.bytebase_environment.dev
-}
-```
-
-You can check [examples](https://github.com/bytebase/terraform-provider-bytebase/blob/main/examples/environments) for more usage examples.
 
 <!-- schema generated by tfplugindocs -->
-
 ## Schema
 
 ### Required
 
-- `resource_id` (String) The environment **unique resource id**.
+- `resource_id` (String) The environment unique resource id.
 
 ### Read-Only
 
-- `id` (Number) The ID of this resource.
-- `title` (String) The environment **unique** name.
-- `order` (Number) The environment sorting order. Starting with 1. Lower number appears first in the deployment pipeline.
-- `environment_tier_policy` (String) Check [Environment Tier](https://www.bytebase.com/docs/administration/environment-policy/tier) for details. Should be one of:
-  - `PROTECTED`
-  - `UNPROTECTED`
+- `environment_tier_policy` (String) If marked as PROTECTED, developers cannot execute any query on this environment's databases using SQL Editor by default.
+- `id` (String) The ID of this resource.
+- `order` (Number) The environment sorting order.
+- `title` (String) The environment unique name.
+
+

docs/data-sources/environment.md

@@ -8,35 +8,30 @@ description: |-
 
 # bytebase_environment_list (Data Source)
 
-The environment data source list. You can list environments through `bytebase_environment_list` data source.
+The environment data source list.
 
-## Example Usage
 
-```terraform
-# List environments
-data "bytebase_environment_list" "all" {}
-
-output "all_environments" {
-  value = data.bytebase_environment_list.all.environments
-}
-```
-
-You can check [examples](https://github.com/bytebase/terraform-provider-bytebase/blob/main/examples/environments) for more usage examples.
 
 <!-- schema generated by tfplugindocs -->
-
 ## Schema
 
 ### Optional
 
-- `show_deleted` (Boolean) If also show the deleted environments.
+- `show_deleted` (Boolean) Including removed instance in the response.
 
 ### Read-Only
 
 - `environments` (List of Object) (see [below for nested schema](#nestedatt--environments))
+- `id` (String) The ID of this resource.
 
 <a id="nestedatt--environments"></a>
-
 ### Nested Schema for `environments`
 
-See [Environment Schema](https://registry.terraform.io/providers/bytebase/bytebase/latest/docs/data-sources/environment#schema).
+Read-Only:
+
+- `environment_tier_policy` (String)
+- `order` (Number)
+- `resource_id` (String)
+- `title` (String)
+
+

docs/data-sources/environment_list.md

@@ -8,62 +8,36 @@ description: |-
 
 # bytebase_instance (Data Source)
 
-The instance data source. You can get a single instance through `bytebase_instance` data source.
+The instance data source.
 
-## Example Usage
 
-```terraform
-# Find a instance by resource id "dev-instance" in the "dev" environment.
-data "bytebase_instance" "dev" {
-  resource_id = "dev-instance"
-}
-
-output "instance" {
-  value = data.bytebase_instance.dev
-}
-```
-
-You can check [examples](https://github.com/bytebase/terraform-provider-bytebase/blob/main/examples/instances) for more usage examples.
 
 <!-- schema generated by tfplugindocs -->
-
 ## Schema
 
 ### Required
 
-- `resource_id` (String) The instance **unique resource id**.
+- `resource_id` (String) The instance unique resource id.
 
 ### Read-Only
 
-- `id` (Number) The instance id.
-- `title` (String) The instance name.
-- `engine` (String) The instance engine. Should be one of:
-  - `MYSQL`
-  - `POSTGRES`
-  - `TIDB`
-  - `SNOWFLAKE`
-  - `CLICKHOUSE`
-  - `SQLITE`
-  - `MONGODB`
+- `data_sources` (List of Object) (see [below for nested schema](#nestedatt--data_sources))
+- `engine` (String) The instance engine. Support MYSQL, POSTGRES, TIDB, SNOWFLAKE, CLICKHOUSE, MONGODB, SQLITE, REDIS, ORACLE, SPANNER, MSSQL, REDSHIFT, MARIADB, OCEANBASE.
+- `environment` (String) The environment name for your instance in "environments/{resource id}" format.
 - `external_link` (String) The external console URL managing this instance (e.g. AWS RDS console, your in-house DB instance console)
-- `data_sources` (List of Object) The connection for the instance. You can configure read-only or admin connection account here. (see [below for nested schema](#nestedblock--data_sources))
-- `environment` (String) The environment **unique resource id** for the instance.
-
-<a id="nestedblock--data_sources"></a>
+- `id` (String) The ID of this resource.
+- `title` (String) The instance title.
 
+<a id="nestedatt--data_sources"></a>
 ### Nested Schema for `data_sources`
 
-#### Read-Only
+Read-Only:
+
+- `database` (String)
+- `host` (String)
+- `port` (String)
+- `title` (String)
+- `type` (String)
+- `username` (String)
+
 
-- `title` (String) The unique data source name in this instance.
-- `type` (String) The data source type. Should be one of:
-  - `ADMIN`: The ADMIN type of data source.
-  - `READ_ONLY`: The read-only type of data source.
-- `username` (String) The connection user name used by Bytebase to perform DDL and DML operations.
-- `password` (String) The connection user password used by Bytebase to perform DDL and DML operations.
-- `ssl_ca` (String) The CA certificate. Optional, you can set this if the engine type is `CLICKHOUSE`.
-- `ssl_cert` (String) The client certificate. Optional, you can set this if the engine type is `CLICKHOUSE`.
-- `ssl_key` (String) The client key. Optional, you can set this if the engine type is `CLICKHOUSE`.
-- `host` (String) Host or socket for the data source, or the account name if the instance type is Snowflake.
-- `port` (String) The port for the data source.
-- `database` (String) The database for the data source.

docs/data-sources/instance.md

@@ -8,39 +8,44 @@ description: |-
 
 # bytebase_instance_list (Data Source)
 
-The instance data source list. You can list instances through `bytebase_instance_list` data source.
+The instance data source list.
 
-## Example Usage
 
-```terraform
-# List all instances in all environments
-data "bytebase_instance_list" "all" {}
-
-output "all_instances" {
-  value = data.bytebase_instance_list.all
-}
-```
-
-You can check [examples](https://github.com/bytebase/terraform-provider-bytebase/blob/main/examples/instances) for more usage examples.
 
 <!-- schema generated by tfplugindocs -->
-
 ## Schema
 
 ### Optional
 
-- `show_deleted` (Boolean) If also show the deleted instances.
+- `show_deleted` (Boolean) Including removed instance in the response.
 
 ### Read-Only
 
+- `id` (String) The ID of this resource.
 - `instances` (List of Object) (see [below for nested schema](#nestedatt--instances))
 
 <a id="nestedatt--instances"></a>
-
 ### Nested Schema for `instances`
 
-See [Instance Schema](https://registry.terraform.io/providers/bytebase/bytebase/latest/docs/data-sources/instance#schema).
+Read-Only:
+
+- `data_sources` (List of Object) (see [below for nested schema](#nestedobjatt--instances--data_sources))
+- `engine` (String)
+- `environment` (String)
+- `external_link` (String)
+- `resource_id` (String)
+- `title` (String)
+
+<a id="nestedobjatt--instances--data_sources"></a>
+### Nested Schema for `instances.data_sources`
+
+Read-Only:
+
+- `database` (String)
+- `host` (String)
+- `port` (String)
+- `title` (String)
+- `type` (String)
+- `username` (String)
 
-### Nested Schema for `data_sources`
 
-See [Data Source Schema](https://registry.terraform.io/providers/bytebase/bytebase/latest/docs/data-sources/instance#nested-schema-for-data_sources).