mirror of
https://github.com/nextcloud/server.git
synced 2026-06-18 05:00:03 -04:00
57 lines
1.6 KiB
PHP
57 lines
1.6 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
/**
|
|
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
|
|
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
|
|
* SPDX-License-Identifier: AGPL-3.0-only
|
|
*/
|
|
namespace OCP\Diagnostics;
|
|
|
|
/**
|
|
* Interface IQueryLogger
|
|
*
|
|
* @since 8.0.0
|
|
* @since 30.0.0 No longer extends `\Doctrine\DBAL\Logging\SQLLogger` as it was removed upstream
|
|
*/
|
|
interface IQueryLogger {
|
|
/**
|
|
* Mark the start of a query providing query SQL statement, its parameters and types.
|
|
* This method should be called as close to the DB as possible and after
|
|
* query is finished finalized with stopQuery() method.
|
|
*
|
|
* @param string $sql
|
|
* @param array|null $params
|
|
* @param array|null $types
|
|
* @since 8.0.0
|
|
* @since 30.0.0 All arguments are typed
|
|
*/
|
|
public function startQuery(string $sql, ?array $params = null, ?array $types = null): void;
|
|
|
|
/**
|
|
* Mark the end of the current active query. Ending query should store \OCP\Diagnostics\IQuery to
|
|
* be returned with getQueries() method.
|
|
*
|
|
* @since 8.0.0
|
|
*/
|
|
public function stopQuery(): void;
|
|
|
|
/**
|
|
* This method should return all \OCP\Diagnostics\IQuery objects stored using
|
|
* startQuery()/stopQuery() methods.
|
|
*
|
|
* @return IQuery[]
|
|
* @since 8.0.0
|
|
*/
|
|
public function getQueries(): array;
|
|
|
|
/**
|
|
* Activate the module for the duration of the request. Deactivated module
|
|
* does not create and store \OCP\Diagnostics\IQuery objects.
|
|
* Only activated module should create and store objects to be
|
|
* returned with getQueries() call.
|
|
*
|
|
* @since 12.0.0
|
|
*/
|
|
public function activate(): void;
|
|
}
|