`w.shares`: Shares¶

class databricks.sdk.service.sharing.SharesAPI¶

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.

create(name: str [, comment: Optional[str]]) → ShareInfo¶

Usage:

import time

from databricks.sdk import WorkspaceClient

w = WorkspaceClient()

created_share = w.shares.create(name=f'sdk-{time.time_ns()}')

# cleanup
w.shares.delete(name=created_share.name)

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.

Parameters:

name – str Name of the share.
comment – str (optional) User-provided free-form text description.

Returns:

ShareInfo

delete(name: str)¶

Delete a share.

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

Parameters:: name – str The name of the share.

get(name: str [, include_shared_data: Optional[bool]]) → ShareInfo¶

Usage:

import time

from databricks.sdk import WorkspaceClient

w = WorkspaceClient()

created_share = w.shares.create(name=f'sdk-{time.time_ns()}')

_ = w.shares.get(name=created_share.name)

# cleanup
w.shares.delete(name=created_share.name)

Get a share.

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

Parameters:

name – str The name of the share.
include_shared_data – bool (optional) Query for data to include in the share.

Returns:

ShareInfo

list() → Iterator[ShareInfo]¶

Usage:

from databricks.sdk import WorkspaceClient

w = WorkspaceClient()

all = w.shares.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.

Returns:: Iterator over ShareInfo

share_permissions(name: str) → catalog.PermissionsList¶

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.

Parameters:: name – str The name of the share.
Returns:: PermissionsList

update(name: str [, comment: Optional[str], new_name: Optional[str], owner: Optional[str], updates: Optional[List[SharedDataObjectUpdate]]]) → ShareInfo¶

Usage:

import os
import time

from databricks.sdk import WorkspaceClient
from databricks.sdk.service import sharing

w = WorkspaceClient()

table_name = f'sdk-{time.time_ns()}'

created_catalog = w.catalogs.create(name=f'sdk-{time.time_ns()}')

created_schema = w.schemas.create(name=f'sdk-{time.time_ns()}', catalog_name=created_catalog.name)

_ = w.statement_execution.execute(
    warehouse_id=os.environ["TEST_DEFAULT_WAREHOUSE_ID"],
    catalog=created_catalog.name,
    schema=created_schema.name,
    statement="CREATE TABLE %s TBLPROPERTIES (delta.enableDeletionVectors=false) AS SELECT 2+2 as four" %
    (table_name)).result()

table_full_name = "%s.%s.%s" % (created_catalog.name, created_schema.name, table_name)

created_share = w.shares.create(name=f'sdk-{time.time_ns()}')

_ = w.shares.update(name=created_share.name,
                    updates=[
                        sharing.SharedDataObjectUpdate(action=sharing.SharedDataObjectUpdateAction.ADD,
                                                       data_object=sharing.SharedDataObject(
                                                           name=table_full_name, data_object_type="TABLE"))
                    ])

# cleanup
w.schemas.delete(full_name=created_schema.full_name)
w.catalogs.delete(name=created_catalog.name, force=True)
w.tables.delete(full_name=table_full_name)
w.shares.delete(name=created_share.name)

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.

Parameters:

name – str The name of the share.
comment – str (optional) User-provided free-form text description.
new_name – str (optional) New name for the share.
owner – str (optional) Username of current owner of share.
updates – List[SharedDataObjectUpdate] (optional) Array of shared data object updates.

Returns:

ShareInfo

update_permissions(name: str [, changes: Optional[List[catalog.PermissionsChange]]])¶

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.

Parameters:

name – str The name of the share.
changes – List[PermissionsChange] (optional) Array of permission changes.

Navigation

Related Topics

`w.shares`: Shares¶

w.shares: Shares¶

`w.shares`: Shares¶