File: DBSchema.h

package info (click to toggle)
thunderbird 1:60.8.0-1~deb9u1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 2,339,208 kB
  • sloc: cpp: 5,456,704; ansic: 2,360,384; python: 596,095; asm: 340,963; java: 326,291; xml: 258,664; sh: 84,366; makefile: 23,702; perl: 17,317; objc: 3,768; yacc: 1,766; ada: 1,681; lex: 1,364; pascal: 1,264; cs: 879; exp: 527; php: 436; lisp: 258; ruby: 153; awk: 152; sed: 53; csh: 27
file content (115 lines) | stat: -rw-r--r-- 4,611 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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/. */

#ifndef mozilla_dom_cache_DBSchema_h
#define mozilla_dom_cache_DBSchema_h

#include "mozilla/Attributes.h"
#include "mozilla/dom/cache/Types.h"
#include "nsError.h"
#include "nsString.h"
#include "nsTArrayForwardDeclare.h"

class mozIStorageConnection;
struct nsID;

namespace mozilla {
namespace dom {
namespace cache {

class CacheQueryParams;
class CacheRequest;
class CacheRequestOrVoid;
class CacheResponse;
struct SavedRequest;
struct SavedResponse;

namespace db {

// Note, this cannot be executed within a transaction.
nsresult CreateOrMigrateSchema(mozIStorageConnection* aConn);

// Note, this cannot be executed within a transaction.
nsresult InitializeConnection(mozIStorageConnection* aConn);

nsresult CreateCacheId(mozIStorageConnection* aConn, CacheId* aCacheIdOut);

nsresult DeleteCacheId(mozIStorageConnection* aConn, CacheId aCacheId,
                       nsTArray<nsID>& aDeletedBodyIdListOut,
                       int64_t* aDeletedPaddingSizeOut);

// TODO: Consider removing unused IsCacheOrphaned after writing cleanup code.
// (bug 1110446)
nsresult IsCacheOrphaned(mozIStorageConnection* aConn, CacheId aCacheId,
                         bool* aOrphanedOut);

nsresult FindOrphanedCacheIds(mozIStorageConnection* aConn,
                              nsTArray<CacheId>& aOrphanedListOut);

nsresult FindOverallPaddingSize(mozIStorageConnection* aConn,
                                int64_t* aOverallPaddingSizeOut);

nsresult GetKnownBodyIds(mozIStorageConnection* aConn,
                         nsTArray<nsID>& aBodyIdListOut);

nsresult CacheMatch(mozIStorageConnection* aConn, CacheId aCacheId,
                    const CacheRequest& aRequest,
                    const CacheQueryParams& aParams, bool* aFoundResponseOut,
                    SavedResponse* aSavedResponseOut);

nsresult CacheMatchAll(mozIStorageConnection* aConn, CacheId aCacheId,
                       const CacheRequestOrVoid& aRequestOrVoid,
                       const CacheQueryParams& aParams,
                       nsTArray<SavedResponse>& aSavedResponsesOut);

nsresult CachePut(mozIStorageConnection* aConn, CacheId aCacheId,
                  const CacheRequest& aRequest, const nsID* aRequestBodyId,
                  const CacheResponse& aResponse, const nsID* aResponseBodyId,
                  nsTArray<nsID>& aDeletedBodyIdListOut,
                  int64_t* aDeletedPaddingSizeOut);

nsresult CacheDelete(mozIStorageConnection* aConn, CacheId aCacheId,
                     const CacheRequest& aRequest,
                     const CacheQueryParams& aParams,
                     nsTArray<nsID>& aDeletedBodyIdListOut,
                     int64_t* aDeletedPaddingSizeOut, bool* aSuccessOut);

nsresult CacheKeys(mozIStorageConnection* aConn, CacheId aCacheId,
                   const CacheRequestOrVoid& aRequestOrVoid,
                   const CacheQueryParams& aParams,
                   nsTArray<SavedRequest>& aSavedRequestsOut);

nsresult StorageMatch(mozIStorageConnection* aConn, Namespace aNamespace,
                      const CacheRequest& aRequest,
                      const CacheQueryParams& aParams, bool* aFoundResponseOut,
                      SavedResponse* aSavedResponseOut);

nsresult StorageGetCacheId(mozIStorageConnection* aConn, Namespace aNamespace,
                           const nsAString& aKey, bool* aFoundCacheOut,
                           CacheId* aCacheIdOut);

nsresult StoragePutCache(mozIStorageConnection* aConn, Namespace aNamespace,
                         const nsAString& aKey, CacheId aCacheId);

nsresult StorageForgetCache(mozIStorageConnection* aConn, Namespace aNamespace,
                            const nsAString& aKey);

nsresult StorageGetKeys(mozIStorageConnection* aConn, Namespace aNamespace,
                        nsTArray<nsString>& aKeysOut);

// Note, this works best when its NOT executed within a transaction.
nsresult IncrementalVacuum(mozIStorageConnection* aConn);

// We will wipe out databases with a schema versions less than this.  Newer
// versions will be migrated on open to the latest schema version.
extern const int32_t kFirstShippedSchemaVersion;

}  // namespace db
}  // namespace cache
}  // namespace dom
}  // namespace mozilla

#endif  // mozilla_dom_cache_DBSchema_h