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) Create a share.
void	delete(DeleteShareRequest deleteShareRequest) Delete a share.
ShareInfo	get(GetShareRequest getShareRequest) Get a share.
ListSharesResponse	list() List shares.
PermissionsList	sharePermissions(SharePermissionsRequest sharePermissionsRequest) Get permissions.
ShareInfo	update(UpdateShare updateShare) Update a share.
void	updatePermissions(UpdateSharePermissions updateSharePermissions) Update permissions.

Method Detail

create

ShareInfo create(CreateShare createShare)

Create a share.

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)

Delete a share.

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

get

ShareInfo get(GetShareRequest getShareRequest)

Get a share.

Gets a data object share from the metastore. The caller must be a metastore admin or the owner of the share.

list

ListSharesResponse list()

List shares.

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.

sharePermissions

PermissionsList sharePermissions(SharePermissionsRequest sharePermissionsRequest)

Get permissions.

Gets the permissions for a data share from the metastore. The caller must be a metastore admin or the owner of the share.

update

ShareInfo update(UpdateShare updateShare)

Update a share.

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 that the share name is changed, **updateShare** requires that the caller is both the share owner and a metastore admin.

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

void updatePermissions(UpdateSharePermissions updateSharePermissions)

Update permissions.

Updates the permissions for a data share in the metastore. The caller must be a metastore admin or an 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.