Skip to content

Commit fdc988f

Browse files
authored
Fix some docs (#2365)
1 parent 75af623 commit fdc988f

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

docs/resources/volume.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ subcategory: "Unity Catalog"
44
# databricks_volume (Resource)
55
Volumes are a new Unity Catalog (UC) capability for accessing, storing, governing, and organizing files. Volumes unlock new processing capabilities for data governed by the Unity Catalog, including support for most machine learning and data science workloads. You can use volumes to store and access files in any format; data can be structured, semi-structured, or unstructured.
66

7-
With Volumes, files managed centrally in Unity Catalogare are organized under a 3-level namespace: `<catalog>.<schema>.<volume>`.
7+
Volumes are organized under a 3-level namespace: `<catalog>.<schema>.<volume>`.
88

9-
This resource does Creates, Read, Update, Delete and List Unity Catalog volumes.
9+
This resource manages Volumes in Unity Catalog.
1010

1111
## Example Usage
1212

@@ -21,9 +21,9 @@ resource "databricks_catalog" "sandbox" {
2121
}
2222
2323
resource "databricks_schema" "things" {
24-
catalog_name = databricks_catalog.sandbox.id
24+
catalog_name = databricks_catalog.sandbox.name
2525
name = "things"
26-
comment = "this database is managed by terraform"
26+
comment = "this schema is managed by terraform"
2727
properties = {
2828
kind = "various"
2929
}
@@ -39,14 +39,13 @@ resource "databricks_storage_credential" "external" {
3939
resource "databricks_external_location" "some" {
4040
name = "external-location"
4141
url = "s3://${aws_s3_bucket.external.id}/some"
42-
credential_name = databricks_storage_credential.external.id
42+
credential_name = databricks_storage_credential.external.name
4343
}
4444
4545
resource "databricks_volume" "this" {
4646
name = "quickstart_volume"
4747
catalog_name = databricks_catalog.sandbox.name
48-
schema_name = databricks_schema.things.name
49-
owner = "volume_owner"
48+
schema_name = databricks_schema.things.name
5049
volume_type = "EXTERNAL"
5150
storage_location = databricks_external_location.some.url
5251
comment = "this volume is managed by terraform"
@@ -57,17 +56,17 @@ resource "databricks_volume" "this" {
5756

5857
The following arguments are supported:
5958

60-
* `name` - Name of volume
61-
* `catalog_name` - Name of parent catalog
59+
* `name` - Name of the Volume
60+
* `catalog_name` - Name of parent Catalog
6261
* `schema_name` - Name of parent Schema relative to parent Catalog
63-
* `volume_type` - URL of storage location. Currently only `EXTERNAL` is supported
64-
* `owner` - (Optional) Name of the volume owner
65-
* `storage_location` - (Optional) If `EXTERNAL` volume type is used, then location of that volume
66-
* `comment` - (Optional) User-supplied free-form text.
62+
* `volume_type` - Volume type. `EXTERNAL` or `MANAGED`.
63+
* `owner` - (Optional) Name of the volume owner.
64+
* `storage_location` - (Optional) Path inside an External Location. Only used for `EXTERNAL` Volumes.
65+
* `comment` - (Optional) Free-form text.
6766

6867
## Import
6968

70-
This resource can be imported by `full_name` which is comprised under a 3-level namespace `<catalog>.<schema>.<volume>`
69+
This resource can be imported by `full_name` which is the 3-level Volume identifier: `<catalog>.<schema>.<volume>`
7170

7271
```bash
7372
$ terraform import databricks_volume.this <catalog_name>.<schema_name>.<name>

0 commit comments

Comments
 (0)