mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-23 12:51:06 +00:00
f3e842d937
Add asyncVacuum to mozIStorageAsyncConnection, that dispatches a runnable to the helper thread, where it will execute a full or incremental vacuum, depending on the connection auto_vacuum value. It also supports vacuuming attached schemas. asyncVacuum() supports changing both the page_size and auto_vacuum. Change mozIStorageVacuumParticipant to return a mozIStorageAsyncConnection and allow specifying whether incremental vacuum should be enabled. Change vacuumManager notification from heavy-io-task to vacuum-begin and vacuum-end since the original proposal of notifying heavy IO didn't take off. Cleanup test_vacuum to be able to use instances of the test VacuumParticipant, that means we can remove the no more necessary registerESM hack. Fix Places History as the only cpp consumer. Differential Revision: https://phabricator.services.mozilla.com/D168298
66 lines
2.6 KiB
Plaintext
66 lines
2.6 KiB
Plaintext
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
* vim: sw=2 ts=2 et lcs=trail\:.,tab\:>~ :
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
interface mozIStorageAsyncConnection;
|
|
|
|
/**
|
|
* This interface contains the information that the Storage service needs to
|
|
* vacuum a database. This interface is created as a service through the
|
|
* category manager with the category "vacuum-participant".
|
|
* Please see https://developer.mozilla.org/en/mozIStorageVacuumParticipant for
|
|
* more information.
|
|
*/
|
|
[scriptable, uuid(8f367508-1d9a-4d3f-be0c-ac11b6dd7dbf)]
|
|
interface mozIStorageVacuumParticipant : nsISupports {
|
|
/**
|
|
* The expected page size in bytes for the database. The vacuum manager will
|
|
* try to correct the page size by executing a full vacuum.
|
|
*
|
|
* @note If the database is using the WAL journal mode, the page size won't
|
|
* be changed to the requested value. See bug 634374.
|
|
* @note Valid page size values are powers of 2 between 512 and 65536.
|
|
* The suggested value is mozIStorageConnection::defaultPageSize.
|
|
*/
|
|
readonly attribute long expectedDatabasePageSize;
|
|
|
|
/**
|
|
* Whether the main schema should be using auto_vacuum = INCREMENTAL.
|
|
* This will cause auto_vacuum to change to INCREMENTAL if it's not set yet.
|
|
* It is not possible to change mode of any attached databases through this,
|
|
* to do that you must open a separate connection and use asyncVacuum() on it.
|
|
*/
|
|
readonly attribute boolean useIncrementalVacuum;
|
|
|
|
/**
|
|
* Connection to the database file to be vacuumed.
|
|
*/
|
|
readonly attribute mozIStorageAsyncConnection databaseConnection;
|
|
|
|
/**
|
|
* Notifies when a vacuum operation begins. Listeners should avoid using the
|
|
* database till onEndVacuum is received.
|
|
*
|
|
* @return true to proceed with the vacuum, false if the participant wants to
|
|
* opt-out for now, it will be retried later. Useful when participant
|
|
* is running some other heavy operation that can't be interrupted.
|
|
*
|
|
* @note When a vacuum operation starts or ends it will also dispatch global
|
|
* "vacuum-begin" and "vacuum-end" notifications through the observer
|
|
* service with the data argument being the database filename.
|
|
*/
|
|
boolean onBeginVacuum();
|
|
|
|
/**
|
|
* Notifies when a vacuum operation ends.
|
|
*
|
|
* @param aSucceeded
|
|
* reports if the vacuum succeeded or failed.
|
|
*/
|
|
void onEndVacuum(in boolean aSucceeded);
|
|
};
|