File: //snap/google-cloud-cli/current/lib/googlecloudsdk/command_lib/sql/import_util.py
# -*- coding: utf-8 -*- #
# Copyright 2017 Google LLC. 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.
"""Common utility functions for sql import commands."""
from googlecloudsdk.api_lib.sql import import_util
from googlecloudsdk.api_lib.sql import operations
from googlecloudsdk.api_lib.sql import validate
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.sql import flags
from googlecloudsdk.core import log
from googlecloudsdk.core import properties
from googlecloudsdk.core.console import console_io
def AddBaseImportFlags(
parser, filetype, gz_supported=True, user_supported=True
):
"""Adds the base flags for importing data.
Args:
parser: An argparse parser that you can use to add arguments that go on the
command line after this command. Positional arguments are allowed.
filetype: String, description of the file type being imported.
gz_supported: Boolean, if True then .gz compressed files are supported.
user_supported: Boolean, if True then a Postgres user can be specified.
"""
base.ASYNC_FLAG.AddToParser(parser)
flags.AddInstanceArgument(parser)
uri_help_text = (
'Path to the {filetype} file in Google Cloud Storage from '
'which the import is made. The URI is in the form '
'`gs://bucketName/fileName`.'
)
if gz_supported:
uri_help_text = uri_help_text + (
' Compressed gzip files (.gz) are also supported.'
)
flags.AddUriArgument(parser, uri_help_text.format(filetype=filetype))
if user_supported:
flags.AddUser(parser, 'PostgreSQL user for this import operation.')
def AddBakImportFlags(parser, filetype, gz_supported=True, user_supported=True):
"""Adds the base flags for importing data for bak import.
Args:
parser: An argparse parser that you can use to add arguments that go on the
command line after this command. Positional arguments are allowed.
filetype: String, description of the file type being imported.
gz_supported: Boolean, if True then .gz compressed files are supported.
user_supported: Boolean, if True then a Postgres user can be specified.
"""
base.ASYNC_FLAG.AddToParser(parser)
flags.AddInstanceArgument(parser)
uri_help_text = (
'Path to the {filetype} file in Google Cloud Storage from '
'which the import is made. The URI is in the form '
'`gs://bucketName/fileName`.'
)
if gz_supported:
uri_help_text = uri_help_text + (
' Compressed gzip files (.gz) are also supported.'
)
flags.AddBakImportUriArgument(parser, uri_help_text.format(filetype=filetype))
if user_supported:
flags.AddUser(parser, 'PostgreSQL user for this import operation.')
def RunImportCommand(args, client, import_context):
"""Imports data into a Cloud SQL instance.
Args:
args: argparse.Namespace, The arguments that this command was invoked with.
client: SqlClient instance, with sql_client and sql_messages props, for use
in generating messages and making API calls.
import_context: ImportContext; format-specific import metadata.
Returns:
A dict representing the import operation resource, if '--async' is used,
or else None.
Raises:
HttpException: An HTTP error response was received while executing API
request.
ToolException: An error other than HTTP error occurred while executing the
command.
"""
sql_client = client.sql_client
sql_messages = client.sql_messages
is_bak_import = (
import_context.fileType
== sql_messages.ImportContext.FileTypeValueValuesEnum.BAK
)
is_tde_import = (
import_context.fileType
== sql_messages.ImportContext.FileTypeValueValuesEnum.TDE
)
import_source = args.cert_path if is_tde_import else args.uri
validate.ValidateInstanceName(args.instance)
if is_bak_import:
validate.ValidateURI(import_source, args.recovery_only)
instance_ref = client.resource_parser.Parse(
args.instance,
params={'project': properties.VALUES.core.project.GetOrFail},
collection='sql.instances',
)
if is_bak_import and args.recovery_only:
console_io.PromptContinue(
message=(
'Bring database [{database}] online with recovery-only.'.format(
database=args.database
)
),
default=True,
cancel_on_no=True,
)
else:
console_io.PromptContinue(
message='Data from [{uri}] will be imported to [{instance}].'.format(
uri=import_source, instance=args.instance
),
default=True,
cancel_on_no=True,
)
import_request = sql_messages.SqlInstancesImportRequest(
instance=instance_ref.instance,
project=instance_ref.project,
instancesImportRequest=sql_messages.InstancesImportRequest(
importContext=import_context
),
)
result_operation = sql_client.instances.Import(import_request)
operation_ref = client.resource_parser.Create(
'sql.operations',
operation=result_operation.name,
project=instance_ref.project,
)
if args.async_:
return sql_client.operations.Get(
sql_messages.SqlOperationsGetRequest(
project=operation_ref.project, operation=operation_ref.operation
)
)
message = 'Importing data into Cloud SQL instance'
if is_bak_import and args.recovery_only:
message = 'Bring database online'
operations.OperationsV1Beta4.WaitForOperation(
sql_client, operation_ref, message
)
if is_bak_import and args.recovery_only:
log.status.write(
'Bring database [{database}] online with recovery-only.\n'.format(
database=args.database
)
)
else:
log.status.write(
'Imported data from [{bucket}] into [{instance}].\n'.format(
instance=instance_ref, bucket=import_source
)
)
return None
def RunSqlImportCommand(args, client):
"""Imports data from a SQL dump file into Cloud SQL instance.
Args:
args: argparse.Namespace, The arguments that this command was invoked with.
client: SqlClient instance, with sql_client and sql_messages props, for use
in generating messages and making API calls.
Returns:
A dict representing the import operation resource, if '--async' is used,
or else None.
"""
sql_import_context = import_util.SqlImportContext(
client.sql_messages,
args.uri,
args.database,
args.user,
parallel=args.parallel,
threads=args.threads,
clean=args.clean,
if_exists=args.if_exists,
)
return RunImportCommand(args, client, sql_import_context)
def RunCsvImportCommand(args, client):
"""Imports data from a CSV file into Cloud SQL instance.
Args:
args: argparse.Namespace, The arguments that this command was invoked with.
client: SqlClient instance, with sql_client and sql_messages props, for use
in generating messages and making API calls.
Returns:
A dict representing the import operation resource, if '--async' is used,
or else None.
"""
csv_import_context = import_util.CsvImportContext(
client.sql_messages,
args.uri,
args.database,
args.table,
args.columns,
args.user,
args.quote,
args.escape,
args.fields_terminated_by,
args.lines_terminated_by,
)
return RunImportCommand(args, client, csv_import_context)
def RunBakImportCommand(args, client):
"""Imports data from a BAK file into Cloud SQL instance.
Args:
args: argparse.Namespace, The arguments that this command was invoked with.
client: SqlClient instance, with sql_client and sql_messages props, for use
in generating messages and making API calls.
Returns:
A dict representing the import operation resource, if '--async' is used,
or else None.
"""
sql_import_context = import_util.BakImportContext(
client.sql_messages,
args.uri,
args.database,
args.cert_path,
args.pvk_path,
args.pvk_password,
args.keep_encrypted,
args.striped,
args.no_recovery,
args.recovery_only,
args.bak_type,
args.stop_at,
args.stop_at_mark,
)
return RunImportCommand(args, client, sql_import_context)
def RunTdeImportCommand(args, client):
"""Imports data from a TDE certificate file into Cloud SQL instance.
Args:
args: argparse.Namespace, The arguments that this command was invoked with.
client: SqlClient instance, with sql_client and sql_messages props, for use
in generating messages and making API calls.
Returns:
A dict representing the import operation resource, if '--async' is used,
or else None.
"""
tde_import_context = import_util.TdeImportContext(
client.sql_messages,
args.certificate,
args.cert_path,
args.pvk_path,
args.pvk_password,
)
return RunImportCommand(args, client, tde_import_context)