execute_sql ¶

def execute_sql(
    self,
    db_cluster_or_instance_arn: "capo_rds_data.types.arn.Arn",
    aws_secret_store_arn: "capo_rds_data.types.arn.Arn",
    sql_statements: "capo_rds_data.types.sql_statement.SqlStatement",
    *,
    config_overrides: Optional[RDSDataClientConfig] = None,
    database: Optional["capo_rds_data.types.db_name.DbName"] = None,
    schema: Optional["capo_rds_data.types.db_name.DbName"] = None,
) -> "capo_rds_data.types.execute_sql_response.ExecuteSqlResponse":
    """<p>Runs one or more SQL statements.</p> <note> <p>This operation is deprecated. Please use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation.</p> </note>

    Args:
        db_cluster_or_instance_arn: <p>The ARN of the Aurora Serverless DB cluster.</p>
        aws_secret_store_arn: <p>The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.</p> <p>For information about creating the secret, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html">Create a database secret</a>.</p>
        sql_statements: <p>One or more SQL statements to run on the DB cluster.</p> <p>You can separate SQL statements from each other with a semicolon (;). Any valid SQL statement is permitted, including data definition, data manipulation, and commit statements. </p>
        database: <p>The name of the database.</p>
        schema: <p>The name of the database schema.</p>

    Raises:
        capo_rds_data.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action.</p>
        capo_rds_data.errors.bad_request_exception.BadRequestException: <p>There is an error in the call or in a SQL statement. This exception is deprecated.</p>
        capo_rds_data.errors.forbidden_exception.ForbiddenException: <p>There are insufficient privileges to make the call.</p>
        capo_rds_data.errors.internal_server_error_exception.InternalServerErrorException: <p>An internal error occurred.</p>
        capo_rds_data.errors.service_unavailable_error.ServiceUnavailableError: <p>The service specified by the <code>resourceArn</code> parameter isn't available.</p>
        capo_rds_data.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_rds_data.types.execute_sql_request.ExecuteSqlRequest]",
    ) -> OperationResponse[
        "capo_rds_data.types.execute_sql_response.ExecuteSqlResponse"
    ]:
        import capo_rds_data._operations.rds_data_service.execute_sql

        output, http_response = (
            capo_rds_data._operations.rds_data_service.execute_sql.execute_sql(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ExecuteSql")
    )
    input_: capo_rds_data.types.execute_sql_request.ExecuteSqlRequest = {
        "db_cluster_or_instance_arn": db_cluster_or_instance_arn,
        "aws_secret_store_arn": aws_secret_store_arn,
        "sql_statements": sql_statements,
    }
    if database is not None:
        input_["database"] = database
    if schema is not None:
        input_["schema"] = schema

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output