Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
paultyng committed Oct 22, 2022
1 parent 43598bd commit 936e4ea
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 24 deletions.
4 changes: 2 additions & 2 deletions docs/data-sources/driver.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The `sql_driver` datasource allows you to determine which driver is in use by th

### Read-Only

- **id** (String, Deprecated) This attribute is only present for some compatibility issues and should not be used. It will be removed in a future version.
- **name** (String) The name of the driver, currently this will be one of `pgx`, `mysql`, or `sqlserver`.
- `id` (String, Deprecated) This attribute is only present for some compatibility issues and should not be used. It will be removed in a future version.
- `name` (String) The name of the driver, currently this will be one of `pgx`, `mysql`, or `sqlserver`.


6 changes: 3 additions & 3 deletions docs/data-sources/query.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ output "math" {

### Required

- **query** (String) The query to execute. The types in this query will be reflected in the typing of the `result` attribute.
- `query` (String) The query to execute. The types in this query will be reflected in the typing of the `result` attribute.

### Read-Only

- **id** (String, Deprecated) This attribute is only present for some compatibility issues and should not be used. It will be removed in a future version.
- **result** (List of Dynamic) The result of the query. This will be a list of objects. Each object will have attributes with names that match column names and types that match column types. The exact translation of types is dependent upon the database driver.
- `id` (String, Deprecated) This attribute is only present for some compatibility issues and should not be used. It will be removed in a future version.
- `result` (List of Dynamic) The result of the query. This will be a list of objects. Each object will have attributes with names that match column names and types that match column types. The exact translation of types is dependent upon the database driver.


6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ provider "sql" {

### Optional

- **max_idle_conns** (Number) Sets the maximum number of connections in the idle connection pool. Default is `2`. See Go's documentation on [DB.SetMaxIdleConns](https://golang.org/pkg/database/sql/#DB.SetMaxIdleConns).
- **max_open_conns** (Number) Sets the maximum number of open connections to the database. Default is `0` (unlimited). See Go's documentation on [DB.SetMaxOpenConns](https://golang.org/pkg/database/sql/#DB.SetMaxOpenConns).
- **url** (String) Database connection strings are specified via URLs. The URL format is driver dependent but generally has the form: `dbdriver://username:password@host:port/dbname?param1=true&param2=false`. You can optionally set the `SQL_URL` environment variable instead.
- `max_idle_conns` (Number) Sets the maximum number of connections in the idle connection pool. Default is `2`. See Go's documentation on [DB.SetMaxIdleConns](https://golang.org/pkg/database/sql/#DB.SetMaxIdleConns).
- `max_open_conns` (Number) Sets the maximum number of open connections to the database. Default is `0` (unlimited). See Go's documentation on [DB.SetMaxOpenConns](https://golang.org/pkg/database/sql/#DB.SetMaxOpenConns).
- `url` (String) Database connection strings are specified via URLs. The URL format is driver dependent but generally has the form: `dbdriver://username:password@host:port/dbname?param1=true&param2=false`. You can optionally set the `SQL_URL` environment variable instead.
18 changes: 9 additions & 9 deletions docs/resources/migrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,30 +49,30 @@ output "rowcount" {

### Optional

- **migration** (Block List) (see [below for nested schema](#nestedblock--migration))
- `migration` (Block List) (see [below for nested schema](#nestedblock--migration))

### Read-Only

- **complete_migrations** (List of Object) The completed migrations that have been run against your database. This list is used as storage to migrate down or as a trigger for downstream dependencies. (see [below for nested schema](#nestedatt--complete_migrations))
- **id** (String, Deprecated) This attribute is only present for some compatibility issues and should not be used. It will be removed in a future version.
- `complete_migrations` (List of Object) The completed migrations that have been run against your database. This list is used as storage to migrate down or as a trigger for downstream dependencies. (see [below for nested schema](#nestedatt--complete_migrations))
- `id` (String, Deprecated) This attribute is only present for some compatibility issues and should not be used. It will be removed in a future version.

<a id="nestedblock--migration"></a>
### Nested Schema for `migration`

Required:

- **down** (String) The query to run when undoing this migration.
- **id** (String) Identifier can be any string to help identifying the migration in the source.
- **up** (String) The query to run when applying this migration.
- `down` (String) The query to run when undoing this migration.
- `id` (String) Identifier can be any string to help identifying the migration in the source.
- `up` (String) The query to run when applying this migration.


<a id="nestedatt--complete_migrations"></a>
### Nested Schema for `complete_migrations`

Read-Only:

- **down** (String)
- **id** (String)
- **up** (String)
- `down` (String)
- `id` (String)
- `up` (String)


14 changes: 7 additions & 7 deletions docs/resources/migrate_directory.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,24 +35,24 @@ output "rowcount" {

### Required

- **path** (String) The path of the SQL migration files. For a path relative to the current module, use `path.module`.
- `path` (String) The path of the SQL migration files. For a path relative to the current module, use `path.module`.

### Optional

- **single_file_split** (String) Set this to a value if your migration up and down are in a single file, split on some constant string (ie. in the case of [shmig](https://github.com/mbucc/shmig) you would use `-- ==== DOWN ====`).
- `single_file_split` (String) Set this to a value if your migration up and down are in a single file, split on some constant string (ie. in the case of [shmig](https://github.com/mbucc/shmig) you would use `-- ==== DOWN ====`).

### Read-Only

- **complete_migrations** (List of Object) The completed migrations that have been run against your database. This list is used as storage to migrate down or as a trigger for downstream dependencies. (see [below for nested schema](#nestedatt--complete_migrations))
- **id** (String, Deprecated) This attribute is only present for some compatibility issues and should not be used. It will be removed in a future version.
- `complete_migrations` (List of Object) The completed migrations that have been run against your database. This list is used as storage to migrate down or as a trigger for downstream dependencies. (see [below for nested schema](#nestedatt--complete_migrations))
- `id` (String, Deprecated) This attribute is only present for some compatibility issues and should not be used. It will be removed in a future version.

<a id="nestedatt--complete_migrations"></a>
### Nested Schema for `complete_migrations`

Read-Only:

- **down** (String)
- **id** (String)
- **up** (String)
- `down` (String)
- `id` (String)
- `up` (String)


0 comments on commit 936e4ea

Please sign in to comment.