All URIs are relative to http://localhost:8080/api/2.1/unity-catalog
| Method | HTTP request | Description |
|---|---|---|
| createSchema | POST /schemas | Create a schema |
| deleteSchema | DELETE /schemas/{full_name} | Delete a schema |
| getSchema | GET /schemas/{full_name} | Get a schema |
| listSchemas | GET /schemas | List schemas |
| updateSchema | PATCH /schemas/{full_name} | Update a schema |
SchemaInfo createSchema(CreateSchema)
Create a schema
Creates a new schema in the specified catalog.
| Name | Type | Description | Notes |
|---|---|---|---|
| CreateSchema | CreateSchema | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
oas_any_type_not_mapped deleteSchema(full_name, force)
Delete a schema
Deletes the specified schema from the parent catalog.
| Name | Type | Description | Notes |
|---|---|---|---|
| full_name | String | Full name of the schema. | [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
SchemaInfo getSchema(full_name)
Get a schema
Gets the specified schema for a catalog.
| Name | Type | Description | Notes |
|---|---|---|---|
| full_name | String | Full name of the schema. | [default to null] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
ListSchemasResponse listSchemas(catalog_name, max_results, page_token)
List schemas
Gets an array of schemas for a catalog. There is no guarantee of a specific ordering of the elements in the array.
| Name | Type | Description | Notes |
|---|---|---|---|
| catalog_name | String | Parent catalog for schemas of interest. | [default to null] |
| max_results | Integer | Maximum number of schemas 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] |
| page_token | String | Opaque pagination token to go to next page based on previous query. | [optional] [default to null] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
SchemaInfo updateSchema(full_name, UpdateSchema)
Update a schema
Updates the specified schema.
| Name | Type | Description | Notes |
|---|---|---|---|
| full_name | String | Full name of the schema. | [default to null] |
| UpdateSchema | UpdateSchema | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json