File: //snap/google-cloud-cli/current/lib/surface/dataplex/lakes/create.py
# -*- coding: utf-8 -*- #
# Copyright 2021 Google Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Command to create a Dataplex lake resource."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.dataplex import lake
from googlecloudsdk.api_lib.dataplex import util as dataplex_util
from googlecloudsdk.api_lib.util import exceptions as gcloud_exception
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.dataplex import resource_args
from googlecloudsdk.command_lib.util.args import labels_util
from googlecloudsdk.core import log
@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.GA)
class Create(base.Command):
"""Create a Dataplex lake resource.
A lake is a centralized repository for managing data across the
organization, where enterprise data is distributed across many cloud projects,
and stored in a variety of storage services, such as Google Cloud Storage and
BigQuery. A lake provides data admins with tools to organize, secure and
manage their data at scale, and provides data scientists and data engineers an
integrated experience to easily search, discover, analyze and transform data
and associated metadata.
The Lake ID will be used to generate names such as database and dataset names
when publishing metadata to Hive Metastore and BigQuery.
The Lake id must follow these rules:
* Must contain only lowercase letters, numbers, and hyphens.
* Must start with a letter.
* Must end with a number or a letter.
* Must be between 1-63 characters.
* Must be unique within the customer project / location.
"""
detailed_help = {
'EXAMPLES':
"""\
To create a Dataplex lake with name `my-dataplex-lake` in location
`us-central1`, run:
$ {command} my-dataplex-lake --location=us-central
To create a Dataplex lake with name `my-dataplex-lake` in location
`us-central1` with metastore service `service-123abc` attached, run:
$ {command} my-dataplex-lake --location=us-central --metastore-service=projects/my-project/services/service-123abc
""",
}
@staticmethod
def Args(parser):
resource_args.AddLakeResourceArg(parser, 'to create.')
parser.add_argument(
'--validate-only',
action='store_true',
default=False,
help='Validate the create action, but don\'t actually perform it.')
metastore = parser.add_group(
help='Settings to manage metadata publishing to a Hive Metastore from a lake.'
)
metastore.add_argument(
'--metastore-service',
help=""" A relative reference to the Dataproc Metastore
(https://cloud.google.com/dataproc-metastore/docs) service instance into
which metadata will be published. This is of the form:
`projects/{project_number}/locations/{location_id}/services/{service_id}`
where the location matches the location of the lake.""")
parser.add_argument('--description', help='Description of the lake.')
parser.add_argument('--display-name', help='Display name of the lake.')
base.ASYNC_FLAG.AddToParser(parser)
labels_util.AddCreateLabelsFlags(parser)
@gcloud_exception.CatchHTTPErrorRaiseHTTPException(
'Status code: {status_code}. {status_message}.')
def Run(self, args):
lake_ref = args.CONCEPTS.lake.Parse()
dataplex_client = dataplex_util.GetClientInstance()
message = dataplex_util.GetMessageModule()
create_req_op = dataplex_client.projects_locations_lakes.Create(
message.DataplexProjectsLocationsLakesCreateRequest(
lakeId=lake_ref.Name(),
parent=lake_ref.Parent().RelativeName(),
validateOnly=args.validate_only,
googleCloudDataplexV1Lake=message.GoogleCloudDataplexV1Lake(
description=args.description,
displayName=args.display_name,
labels=dataplex_util.CreateLabels(
message.GoogleCloudDataplexV1Lake, args),
metastore=message.GoogleCloudDataplexV1LakeMetastore(
service=args.metastore_service))))
validate_only = getattr(args, 'validate_only', False)
if validate_only:
log.status.Print('Validation complete.')
return
async_ = getattr(args, 'async_', False)
if not async_:
lake.WaitForLongOperation(create_req_op)
log.CreatedResource(
lake_ref.Name(),
details='Lake created in [{0}]'.format(
lake_ref.Parent().RelativeName()))
return
log.status.Print('Creating [{0}] with operation [{1}].'.format(
lake_ref, create_req_op.name))