All URIs are relative to http://localhost:8080/api/2.1/unity-catalog
| Method | HTTP request | Description |
|---|---|---|
| createCatalog | POST /catalogs | Create a catalog |
| deleteCatalog | DELETE /catalogs/{name} | Delete a catalog |
| getCatalog | GET /catalogs/{name} | Get a catalog |
| listCatalogs | GET /catalogs | List catalogs |
| updateCatalog | PATCH /catalogs/{name} | Update a catalog |
CatalogInfo createCatalog(CreateCatalog)
Create a catalog
Creates a new catalog instance.
| Name | Type | Description | Notes |
|---|---|---|---|
| CreateCatalog | CreateCatalog | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
oas_any_type_not_mapped deleteCatalog(name, force)
Delete a catalog
Deletes the catalog that matches the supplied name.
| Name | Type | Description | Notes |
|---|---|---|---|
| name | String | The name of the catalog. | [default to null] |
| force | Boolean | Force deletion even if the catalog is not empty. | [optional] [default to null] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
CatalogInfo getCatalog(name)
Get a catalog
Gets the specified catalog.
| Name | Type | Description | Notes |
|---|---|---|---|
| name | String | The name of the catalog. | [default to null] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
ListCatalogsResponse listCatalogs(page_token, max_results)
List catalogs
Lists the available catalogs. There is no guarantee of a specific ordering of the elements in the list.
| Name | Type | Description | Notes |
|---|---|---|---|
| page_token | String | Opaque pagination token to go to next page based on previous query. | [optional] [default to null] |
| max_results | Integer | Maximum number of catalogs to return. - when set to a value greater than 0, the page length is the minimum of this value and a server configured value; - when set to 0, the page length is set to a server configured value; - when set to a value less than 0, an invalid parameter error is returned; | [optional] [default to null] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
CatalogInfo updateCatalog(name, UpdateCatalog)
Update a catalog
Updates the catalog that matches the supplied name.
| Name | Type | Description | Notes |
|---|---|---|---|
| name | String | The name of the catalog. | [default to null] |
| UpdateCatalog | UpdateCatalog | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json