Skip to content

Commit d01dbc8

Browse files
zphzph
committed
Update some of docs but not all
1 parent 00de0c2 commit d01dbc8

File tree

6 files changed

+125
-137
lines changed

6 files changed

+125
-137
lines changed

‎docs/data-sources/databases.md

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,25 @@
11
---
2-
layout: "mysql"
3-
page_title: "MySQL: mysql_databases"
4-
sidebar_current: "docs-mysql-datasource-databases"
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "mysql_databases Data Source - terraform-provider-mysql"
4+
subcategory: ""
55
description: |-
6-
Gets databases on a MySQL server.
6+
77
---
88

9-
# Data Source: mysql\_databases
9+
# mysql_databases (Data Source)
1010

11-
The ``mysql_databases`` gets databases on a MySQL
12-
server.
1311

14-
## Example Usage
1512

16-
```hcl
17-
data "mysql_databases" "app" {
18-
pattern = "test_%"
19-
}
20-
```
2113

22-
## Argument Reference
2314

24-
The following arguments are supported:
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
2517

26-
* `pattern` - (Optional) Patterns for searching databases.
18+
### Optional
2719

28-
## Attributes Reference
20+
- `pattern` (String)
2921

30-
The following attributes are exported:
22+
### Read-Only
3123

32-
* `databases` - The list of the database names.
24+
- `databases` (List of String)
25+
- `id` (String) The ID of this resource.

‎docs/data-sources/tables.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,29 @@
11
---
2-
layout: "mysql"
3-
page_title: "MySQL: mysql_tables"
4-
sidebar_current: "docs-mysql-datasource-tables"
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "mysql_tables Data Source - terraform-provider-mysql"
4+
subcategory: ""
55
description: |-
6-
Gets tables on a MySQL server.
6+
77
---
88

9-
# Data Source: mysql\_tables
9+
# mysql_tables (Data Source)
1010

11-
The ``mysql_tables`` gets tables on a MySQL
12-
server.
1311

14-
## Example Usage
1512

16-
```hcl
17-
data "mysql_tables" "app" {
18-
database = "my_awesome_app"
19-
}
20-
```
2113

22-
## Argument Reference
2314

24-
The following arguments are supported:
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
2517

26-
* `database` - (Required) The name of the database.
27-
* `pattern` - (Optional) Patterns for searching tables.
18+
### Required
2819

29-
## Attributes Reference
20+
- `database` (String)
3021

31-
The following attributes are exported:
22+
### Optional
3223

33-
* `tables` - The list of the table names.
24+
- `pattern` (String)
25+
26+
### Read-Only
27+
28+
- `id` (String) The ID of this resource.
29+
- `tables` (List of String)

‎docs/resources/sql.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "mysql_sql Resource - terraform-provider-mysql"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# mysql_sql (Resource)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `create_sql` (String)
21+
- `delete_sql` (String)
22+
- `name` (String)
23+
24+
### Read-Only
25+
26+
- `id` (String) The ID of this resource.

‎docs/resources/ti_config.md

Lines changed: 15 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -1,113 +1,30 @@
11
---
2-
layout: "mysql"
3-
page_title: "MySQL: mysql_ti_config"
4-
sidebar_current: "docs-mysql-resource-ti-config-variable"
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "mysql_ti_config Resource - terraform-provider-mysql"
4+
subcategory: ""
55
description: |-
6-
Manages a TiKV or PD variables on a TiDB cluster.
6+
77
---
88

9-
# mysql\_ti\_config
9+
# mysql_ti_config (Resource)
1010

11-
The ``mysql_ti_config`` resource manages a TiKV or PD variables on a TiDB cluster.
1211

13-
~> **Note on TiDB:** Possible TiKV or PD variables are available [here](https://docs.pingcap.com/tidb/stable/dynamic-config)
1412

15-
~> **Note about `destroy`:** `destroy` is trying restore default values as described [here](https://github.com/petoju/terraform-provider-mysql/blob/master/mysql/resource_ti_config_defaults.go).
16-
Unfortunately not every variable support this.
1713

18-
## Example Usage
1914

20-
### PD
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
2117

22-
```hcl
23-
resource "mysql_ti_config" "log_level" {
24-
name = "log.level"
25-
value = "warn"
26-
type = "pd"
27-
}
28-
```
18+
### Required
2919

30-
#### Set variable for all PD instances
20+
- `name` (String)
21+
- `type` (String)
22+
- `value` (String)
3123

32-
```hcl
33-
resource "mysql_ti_config" "log_level" {
34-
name = "log.level"
35-
value = "warn"
36-
type = "pd"
37-
}
38-
```
24+
### Optional
3925

40-
#### Set variable for one PD instance only
26+
- `instance` (String)
4127

42-
```hcl
43-
resource "mysql_ti_config" "log_level" {
44-
name = "log.level"
45-
value = "warn"
46-
type = "pd"
47-
instance = "127.0.0.1:2379"
48-
}
49-
```
28+
### Read-Only
5029

51-
## TiKV
52-
53-
### Set varibale for all TiKV instances
54-
55-
```hcl
56-
resource "mysql_ti_config" "split_qps_threshold" {
57-
name = "split.qps-threshold"
58-
value = "100"
59-
type = "tikv"
60-
}
61-
```
62-
63-
#### Set variable for one TiKV instance only
64-
65-
```hcl
66-
resource "mysql_ti_config" "split_qps_threshold" {
67-
name = "split.qps-threshold"
68-
value = "10"
69-
type = "tikv"
70-
instance = "127.0.0.1:20180"
71-
}
72-
```
73-
74-
## Argument Reference
75-
76-
The following arguments are supported:
77-
78-
* `name` - (Required) The name of the configuration variable.
79-
* `value` - (Required) The value of the configuration variable as string.
80-
* `type` - (Required) The instance type to configure. Possible values are tikv or pd.
81-
82-
## Attributes Reference
83-
84-
No further attributes are exported.
85-
86-
## Import
87-
88-
TiKV or PD variable can be imported using global variable name.
89-
90-
General template to import is
91-
92-
```terraform import mysql_ti_config.<tf_name> <pd|tikv#config#optional_instance_name>```
93-
```terraform import mysql_ti_config.<tf_config_name_in_tf_file> <pd|tikv#config_param_to_read#optional_instance_name>```
94-
95-
### Simple example
96-
97-
#### TiKV example
98-
99-
```shell
100-
terraform import 'mysql_ti_config.split_qps_threshold' 'tikv#split-qps-threshold'
101-
```
102-
103-
Import value for specific instance
104-
105-
```shell
106-
terraform import 'mysql_ti_config.split_qps_threshold' 'tikv#split-qps-threshold#127.0.0.1:20180'
107-
```
108-
109-
#### PD example
110-
111-
```shell
112-
terraform import 'mysql_ti_config.log_level' 'pd#log.level'
113-
```
30+
- `id` (String) The ID of this resource.

‎docs/resources/ti_resource_group.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "mysql_ti_resource_group Resource - terraform-provider-mysql"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# mysql_ti_resource_group (Resource)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `name` (String)
21+
- `resource_units` (Number)
22+
23+
### Optional
24+
25+
- `burstable` (Boolean)
26+
- `priority` (String)
27+
- `query_limit` (String)
28+
29+
### Read-Only
30+
31+
- `id` (String) The ID of this resource.

‎docs/resources/ti_resource_group_user_assignment.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "mysql_ti_resource_group_user_assignment Resource - terraform-provider-mysql"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# mysql_ti_resource_group_user_assignment (Resource)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `resource_group` (String)
21+
- `user` (String)
22+
23+
### Read-Only
24+
25+
- `id` (String) The ID of this resource.

0 commit comments

Comments
 (0)