Managing a lake

This page explains how to view, update, and delete an existing Dataplex lake.

Before you begin

Access control

  • To update or delete a lake, you must be granted IAM roles containing the dataplex.lakes.create and the dataplex.lakes.delete IAM permissions respectively. The Dataplex specific roles roles/dataplex.admin and roles/dataplex.editor can be used to grant update and delete permission.

  • You can also give update and delete permission to users or groups by using the roles/owner and roles/editor legacy roles.

For more information, see Dataplex IAM and access control.

Viewing a lake

You can view your Dataplex lake on the Google Cloud console.

  1. Open the Dataplex page in the console:

    Open Dataplex in the console

  2. Click the lake name of the lake you'd like to view on the Dataplex page. The lake page for that lake opens.

    Lake detail page

There are four lake tabs:

  • Details

    You can view lake and discovery details.

  • Zones

    You can manage existing data zones in your lake or add new data zones.

    For more information, see Managing a zone.

  • Permissions

    You can manage lake permissions.

    For more information, see IAM and access control.

  • Actions

    You can view lake-level actions, specifically issues around security policy propagation. Learn more.

Updating a lake

You can update a lake by issuing a Dataplex API method lakes.patch or by editing lake details on the edit lake page opened in a local browser.

Only one update job is supported at a time, and each job can have multiple property updates. You can still use the lake while it's being updated.

The following lake parameters can be updated:

  • Description
  • Labels

The following instructions demonstrate how to update a Dataplex lake using the Google Cloud console or the Dataplex API.

Console

  1. In the console, open the Dataplex page:

    Open Dataplex in the console

  2. On the Dataplex page, click the lake name of the lake you'd like to update. The lake page for that lake opens.

  3. At the top of the page, click the Edit button. The Edit Lake page opens.

  4. Choose the updated lake parameter values.

  5. Click the Save button to update the lake.

  6. Verify that you have returned to the Dataplex page, and that your updated lake appears in the list.

REST

Follow the API instructions to update a lake by using the APIs Explorer.

When the update succeeds, the lake automatically enters active state. If it fails, then the lake is rolled back to its previous healthy state.

Deleting a lake

You can delete a lake by issuing a Dataplex API method lakes.delete or by clicking delete on the lake page opened in a local browser.

You may want to delete your lake if your configurations are wrong and can't be changed.

Lakes cannot be deleted unless all data zone resources under it have been deleted. Similarly, data zones cannot be deleted unless all asset resources under it have been deleted. Users given access to data through these lake or data zones will lose access rights.

The following instructions demonstrate how to delete a Dataplex lake using the Google Cloud console or the Dataplex API.

Console

  1. In the console, open the Dataplex page:

    Open Dataplex in the console

  2. On the Dataplex page, click the lake name of the lake you'd like to delete. The lake page for that lake opens.

  3. At the top of the page, click Delete. The Delete lake dialog opens.

  4. Confirm deletion by typing "delete" in the text box.

  5. Click Delete Lake on to confirm the deletion.

  6. Verify that you have returned to the Dataplex page, and that your deleted lake no longer appears in the list.

REST

Follow the API instructions to delete a lake by using the APIs Explorer.

All deletions cannot be undone and may take a while to complete.

What's next?