<?php

/**
 * Copyright 2019 Colopl 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.
 */

namespace Colopl\Spanner\Concerns;

use Google\Cloud\Spanner\Database;

trait ManagesPartitionedDml
{
    /**
     * @return Database
     */
    abstract public function getSpannerDatabase(): Database;

    /**
     * Run an SQL statement as partitioned DML and get the number of rows affected.
     *
     * @param string $query
     * @param array<array-key, mixed> $bindings
     * @return int
     */
    public function runPartitionedDml($query, $bindings = [])
    {
        /** @var int */
        return $this->run($query, $bindings, function ($query, $bindings) {
            if ($this->pretending()) {
                return 0;
            }

            $rowCount = $this->getSpannerDatabase()->executePartitionedUpdate($query, ['parameters' => $this->prepareBindings($bindings)]);

            $this->recordsHaveBeenModified($rowCount > 0);

            return $rowCount;
        });
    }
}
