unitycatalog_client_preview 1.0.1

Unity Catalog API

unitycatalog-client-preview

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.1
• Package version: 1.0.1
• Generator version: 7.9.0
• Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import unitycatalog_client_preview

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import unitycatalog_client_preview

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import unitycatalog_client_preview
from unitycatalog_client_preview.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8080/api/2.1/unity-catalog
# See configuration.py for a list of all supported configuration parameters.
configuration = unitycatalog_client_preview.Configuration(
    host = "http://localhost:8080/api/2.1/unity-catalog"
)



# Enter a context with an instance of the API client
with unitycatalog_client_preview.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unitycatalog_client_preview.CatalogsApi(api_client)
    create_catalog = unitycatalog_client_preview.CreateCatalog() # CreateCatalog |  (optional)

    try:
        # Create a catalog
        api_response = api_instance.create_catalog(create_catalog=create_catalog)
        print("The response of CatalogsApi->create_catalog:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CatalogsApi->create_catalog: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/api/2.1/unity-catalog

Class	Method	HTTP request	Description
CatalogsApi	create_catalog	POST /catalogs	Create a catalog
CatalogsApi	delete_catalog	DELETE /catalogs/{name}	Delete a catalog
CatalogsApi	get_catalog	GET /catalogs/{name}	Get a catalog
CatalogsApi	list_catalogs	GET /catalogs	List catalogs
CatalogsApi	update_catalog	PATCH /catalogs/{name}	Update a catalog
FunctionsApi	create_function	POST /functions	Create a function. WARNING: This API is experimental and will change in future versions.
FunctionsApi	delete_function	DELETE /functions/{name}	Delete a function
FunctionsApi	get_function	GET /functions/{name}	Get a function
FunctionsApi	list_functions	GET /functions	List functions
GrantsApi	get	GET /permissions/{securable_type}/{full_name}	Get permissions
GrantsApi	update	PATCH /permissions/{securable_type}/{full_name}	Update a permission
MetastoresApi	summary	GET /metastore_summary	Get metastore summary
ModelVersionsApi	create_model_version	POST /models/versions	Create a model version.
ModelVersionsApi	delete_model_version	DELETE /models/{full_name}/versions/{version}	Delete a model version
ModelVersionsApi	finalize_model_version	PATCH /models/{full_name}/versions/{version}/finalize	Finalize a model version
ModelVersionsApi	get_model_version	GET /models/{full_name}/versions/{version}	Get a model version
ModelVersionsApi	list_model_versions	GET /models/{full_name}/versions	List model versions of the specified registered model.
ModelVersionsApi	update_model_version	PATCH /models/{full_name}/versions/{version}	Update a model version
RegisteredModelsApi	create_registered_model	POST /models	Create a model. WARNING: This API is experimental and will change in future versions.
RegisteredModelsApi	delete_registered_model	DELETE /models/{full_name}	Delete a specified registered model.
RegisteredModelsApi	get_registered_model	GET /models/{full_name}	Get a specified registered model
RegisteredModelsApi	list_registered_models	GET /models	List models
RegisteredModelsApi	update_registered_model	PATCH /models/{full_name}	Update a registered model
SchemasApi	create_schema	POST /schemas	Create a schema
SchemasApi	delete_schema	DELETE /schemas/{full_name}	Delete a schema
SchemasApi	get_schema	GET /schemas/{full_name}	Get a schema
SchemasApi	list_schemas	GET /schemas	List schemas
SchemasApi	update_schema	PATCH /schemas/{full_name}	Update a schema
TablesApi	create_table	POST /tables	Create a table. Only external table creation is supported. WARNING: This API is experimental and will change in future versions.
TablesApi	delete_table	DELETE /tables/{full_name}	Delete a table
TablesApi	get_table	GET /tables/{full_name}	Get a table
TablesApi	list_tables	GET /tables	List tables
TablesApi	update_table	PATCH /tables/{full_name}	Update a table
TemporaryCredentialsApi	generate_temporary_model_version_credentials	POST /temporary-model-version-credentials	Generate temporary model version credentials. These credentials are used by clients to write and retrieve model artifacts from the model versions external storage location.
TemporaryCredentialsApi	generate_temporary_path_credentials	POST /temporary-path-credentials	Generate temporary path credentials.
TemporaryCredentialsApi	generate_temporary_table_credentials	POST /temporary-table-credentials	Generate temporary table credentials.
TemporaryCredentialsApi	generate_temporary_volume_credentials	POST /temporary-volume-credentials	Generate temporary volume credentials.
VolumesApi	create_volume	POST /volumes	Create a Volume
VolumesApi	delete_volume	DELETE /volumes/{name}	Delete a Volume
VolumesApi	get_volume	GET /volumes/{name}	Get a Volume
VolumesApi	list_volumes	GET /volumes	List Volumes
VolumesApi	update_volume	PATCH /volumes/{name}	Update a Volume

Documentation For Models

• AwsCredentials
• AzureUserDelegationSAS
• CatalogInfo
• ColumnInfo
• ColumnTypeName
• CreateCatalog
• CreateFunction
• CreateFunctionRequest
• CreateModelVersion
• CreateRegisteredModel
• CreateSchema
• CreateTable
• CreateVolumeRequestContent
• DataSourceFormat
• Dependency
• DependencyList
• FinalizeModelVersion
• FunctionDependency
• FunctionInfo
• FunctionParameterInfo
• FunctionParameterInfos
• FunctionParameterMode
• FunctionParameterType
• GcpOauthToken
• GenerateTemporaryModelVersionCredential
• GenerateTemporaryPathCredential
• GenerateTemporaryTableCredential
• GenerateTemporaryVolumeCredential
• GetMetastoreSummaryResponse
• ListCatalogsResponse
• ListFunctionsResponse
• ListModelVersionsResponse
• ListRegisteredModelsResponse
• ListSchemasResponse
• ListTablesResponse
• ListVolumesResponseContent
• ModelVersionInfo
• ModelVersionOperation
• ModelVersionStatus
• PathOperation
• PermissionsChange
• PermissionsList
• PrincipalType
• Privilege
• PrivilegeAssignment
• RegisteredModelInfo
• SchemaInfo
• SecurableType
• TableDependency
• TableInfo
• TableOperation
• TableType
• TemporaryCredentials
• UpdateCatalog
• UpdateModelVersion
• UpdatePermissions
• UpdateRegisteredModel
• UpdateSchema
• UpdateTable
• UpdateVolumeRequestContent
• VolumeInfo
• VolumeOperation
• VolumeType

Documentation For Authorization

Endpoints do not require authorization.

Author