com.databricks.sdk.service.sharing

Interface SharesService

@Generated
public interface SharesService

A share is a container instantiated with :method:shares/create. Once created you can iteratively register a collection of existing data assets defined within the metastore using :method:shares/update. You can register data assets under their original name, qualified by their original schema, or provide alternate exposed names.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
ShareInfo	create(CreateShare createShare) Creates a new share for data objects.
void	delete(DeleteShareRequest deleteShareRequest) Deletes a data object share from the metastore.
ShareInfo	get(GetShareRequest getShareRequest) Gets a data object share from the metastore.
ListSharesResponse	list(ListSharesRequest listSharesRequest) Gets an array of data object shares from the metastore.
ListSharesResponse	listShares(SharesListRequest sharesListRequest) Gets an array of data object shares from the metastore.
GetSharePermissionsResponse	sharePermissions(SharePermissionsRequest sharePermissionsRequest) Gets the permissions for a data share from the metastore.
ShareInfo	update(UpdateShare updateShare) Updates the share with the changes and data objects in the request.
UpdateSharePermissionsResponse	updatePermissions(UpdateSharePermissions updateSharePermissions) Updates the permissions for a data share in the metastore.

Method Detail

create

ShareInfo create(CreateShare createShare)

Creates a new share for data objects. Data objects can be added after creation with **update**. The caller must be a metastore admin or have the **CREATE_SHARE** privilege on the metastore.

delete

void delete(DeleteShareRequest deleteShareRequest)

Deletes a data object share from the metastore. The caller must be an owner of the share.

get

ShareInfo get(GetShareRequest getShareRequest)

Gets a data object share from the metastore. The caller must have the USE_SHARE privilege on the metastore or be the owner of the share.

listShares

ListSharesResponse listShares(SharesListRequest sharesListRequest)

Gets an array of data object shares from the metastore. If the caller has the USE_SHARE privilege on the metastore, all shares are returned. Otherwise, only shares owned by the caller are returned. There is no guarantee of a specific ordering of the elements in the array.

sharePermissions

GetSharePermissionsResponse sharePermissions(SharePermissionsRequest sharePermissionsRequest)

Gets the permissions for a data share from the metastore. The caller must have the USE_SHARE privilege on the metastore or be the owner of the share.

update

ShareInfo update(UpdateShare updateShare)

Updates the share with the changes and data objects in the request. The caller must be the owner of the share or a metastore admin.

When the caller is a metastore admin, only the __owner__ field can be updated.

In the case the share name is changed, **updateShare** requires that the caller is the owner of the share and has the CREATE_SHARE privilege.

If there are notebook files in the share, the __storage_root__ field cannot be updated.

For each table that is added through this method, the share owner must also have **SELECT** privilege on the table. This privilege must be maintained indefinitely for recipients to be able to access the table. Typically, you should use a group as the share owner.

Table removals through **update** do not require additional privileges.

updatePermissions

UpdateSharePermissionsResponse updatePermissions(UpdateSharePermissions updateSharePermissions)

Updates the permissions for a data share in the metastore. The caller must have both the USE_SHARE and SET_SHARE_PERMISSION privileges on the metastore, or be the owner of the share.

For new recipient grants, the user must also be the owner of the recipients. recipient revocations do not require additional privileges.

list

ListSharesResponse list(ListSharesRequest listSharesRequest)

Gets an array of data object shares from the metastore. The caller must be a metastore admin or the owner of the share. There is no guarantee of a specific ordering of the elements in the array.