Skip to content

Commit 51aa4b8

Browse files
refucktorrefucktor
committed
docs: add generated docs for terraform registry
1 parent 22207a0 commit 51aa4b8

File tree

4 files changed

+153
-0
lines changed

4 files changed

+153
-0
lines changed

‎.goreleaser.yml

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Visit https://goreleaser.com for documentation on how to customize this behavior.
2+
version: 2
23
before:
34
hooks:
45
# this is just an example and not a requirement for provider building/publishing

‎docs/data-sources/event_trigger.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "postgresql_event_trigger Data Source - postgresql"
4+
subcategory: ""
5+
description: |-
6+
Event Trigger is a PostgreSQL object that allows you to define a set of actions that should be executed when a certain event occurs.
7+
They are are global objects for a particular database and are capable of capturing events from multiple tables.
8+
(PostgreSQL Event Triggers)[https://www.postgresql.org/docs/current/event-triggers.html]
9+
---
10+
11+
# postgresql_event_trigger (Data Source)
12+
13+
Event Trigger is a PostgreSQL object that allows you to define a set of actions that should be executed when a certain event occurs.
14+
They are are global objects for a particular database and are capable of capturing events from multiple tables.
15+
(PostgreSQL Event Triggers)[https://www.postgresql.org/docs/current/event-triggers.html]
16+
17+
18+
19+
<!-- schema generated by tfplugindocs -->
20+
## Schema
21+
22+
### Required
23+
24+
- `database` (String) Name of the database where the event trigger is located
25+
- `name` (String) Name of the event trigger
26+
27+
### Read-Only
28+
29+
- `comment` (String) Comment associated with the event trigger
30+
- `enabled` (Boolean) Whether the event trigger is enabled
31+
- `event` (String) The event that triggers the event trigger
32+
- `exec_func` (String) The Function that will be executed when the event trigger fires
33+
- `owner` (String) The owner of the event trigger
34+
- `tags` (Set of String) List of command tags that the event trigger will respond to

‎docs/index.md

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "postgresql Provider"
4+
subcategory: ""
5+
description: |-
6+
Yet another Terraform provider for PostgreSQL. This one is built using the latest and suggested practices for
7+
Terraform providers. That means it is built using the (Terraform Plugin Framework)[https://developer.hashicorp.com/terraform/plugin/framework].
8+
❗ READ BEFORE USE
9+
This provider is still in development and has a limited support for PostgreSQL resources.Check the 🏁 Roadmap for the list of supported resources.
10+
🏁 Roadmap
11+
| Name | Resource | Data Source |
12+
|---------------|:--------:|:-----------:|
13+
| Event Trigger | ✅ | ✅ |
14+
| Functions | 🔜 | 🔜 |
15+
| Database | 🔜 | 🔜 |
16+
| Schema | 🔜 | 🔜 |
17+
| Role | 🔜 | 🔜 |
18+
---
19+
20+
# postgresql Provider
21+
22+
Yet another Terraform provider for PostgreSQL. This one is built using the latest and suggested practices for
23+
Terraform providers. That means it is built using the (Terraform Plugin Framework)[https://developer.hashicorp.com/terraform/plugin/framework].
24+
25+
## ❗ READ BEFORE USE
26+
27+
* This provider is still in development and has a limited support for PostgreSQL resources.
28+
* Check the [🏁 Roadmap](#-roadmap) for the list of supported resources.
29+
30+
## 🏁 Roadmap
31+
32+
| Name | Resource | Data Source |
33+
|---------------|:--------:|:-----------:|
34+
| Event Trigger | ✅ | ✅ |
35+
| Functions | 🔜 | 🔜 |
36+
| Database | 🔜 | 🔜 |
37+
| Schema | 🔜 | 🔜 |
38+
| Role | 🔜 | 🔜 |
39+
40+
## Example Usage
41+
42+
```terraform
43+
terraform {
44+
required_providers {
45+
postgresql = {
46+
source = "registry.terraform.io/inventium-tech/postgresql"
47+
}
48+
}
49+
}
50+
51+
provider "postgresql" {
52+
host = "localhost"
53+
port = 5432
54+
username = "postgres"
55+
password = "password"
56+
}
57+
```
58+
59+
<!-- schema generated by tfplugindocs -->
60+
## Schema
61+
62+
### Optional
63+
64+
- `database` (String) The name of the PostgreSQL database to connect to.
65+
- `host` (String) The hostname of the PostgreSQL server. Default is 5432)
66+
- `max_idle_conn` (Number) Maximum number of idle connections to the database. Default is 5.
67+
- `max_open_conn` (Number) Maximum number of open connections to the database. Default is 0.
68+
- `password` (String, Sensitive) The password to use when connecting to the PostgreSQL server.
69+
- `port` (Number) The port of the PostgreSQL server.
70+
- `scheme` (String) The schema to use when connecting to the PostgreSQL database. The value must be one of the following:
71+
* 'postgres'
72+
* 'gcppostgres'
73+
* 'awspostgres'
74+
- `sslmode` (String) The SSL mode to use when connecting to the PostgreSQL server. The value must be one of the following:
75+
* 'disable' (No SSL)
76+
* 'require' (*default*. Always SSL, skip verification)
77+
* 'verify-ca' (Always SSL, verify that the server certificate is issued by a trusted CA)
78+
* 'verify-full' (Always SSL, *same as 'verify-ca', plus the server host name matches the one in the certificate)
79+
- `username` (String) The username to use when connecting to the PostgreSQL server.

‎docs/resources/event_trigger.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "postgresql_event_trigger Resource - postgresql"
4+
subcategory: ""
5+
description: |-
6+
Event Trigger is a PostgreSQL object that allows you to define a set of actions that should be executed when a certain event occurs.
7+
They are are global objects for a particular database and are capable of capturing events from multiple tables.
8+
(PostgreSQL Event Triggers)[https://www.postgresql.org/docs/current/event-triggers.html]
9+
---
10+
11+
# postgresql_event_trigger (Resource)
12+
13+
Event Trigger is a PostgreSQL object that allows you to define a set of actions that should be executed when a certain event occurs.
14+
They are are global objects for a particular database and are capable of capturing events from multiple tables.
15+
(PostgreSQL Event Triggers)[https://www.postgresql.org/docs/current/event-triggers.html]
16+
17+
18+
19+
<!-- schema generated by tfplugindocs -->
20+
## Schema
21+
22+
### Required
23+
24+
- `event` (String) The event that will trigger the event trigger
25+
- `exec_func` (String) The function that will be executed when the event trigger fires
26+
- `name` (String) Name of the event trigger
27+
28+
### Optional
29+
30+
- `comment` (String) Comment associated with the event trigger
31+
- `database` (String) Name of the database where the event trigger is located. If not provided, the database from the provider configuration will be used.
32+
- `enabled` (Boolean) Whether the event trigger is enabled
33+
- `owner` (String) The owner of the event trigger
34+
- `tags` (Set of String) List of command tags that the event trigger will respond to
35+
36+
### Read-Only
37+
38+
- `id` (String) The unique identifier for the event trigger, in the format `database_name.event_trigger_name`
39+
- `last_updated` (String) The timestamp of the last modification of the event trigger

0 commit comments

Comments
 (0)