platform/data/profile-db

Classes

ProfileDatabase

Defined in: app/src/platform/data/profile-db.ts:120

The profile database profile.db: history with full-text search, bookmarks and the list of downloads. It runs in the data service process, never in the browser process, because SQLite calls block. Schema changes run as numbered migrations; before one runs on an existing database, a copy is written next to it with VACUUM INTO. A database from a newer version is opened read-only, so an older version never changes data it does not understand.

Constructors

Constructor

new ProfileDatabase(path, clock?): ProfileDatabase

Defined in: app/src/platform/data/profile-db.ts:130

Parameters

path

string

Path of profile.db, or :memory: in tests.

clock?

() => number

Current time in milliseconds since 1970.

Returns

ProfileDatabase

Properties

readOnly

readonly readOnly: boolean

Defined in: app/src/platform/data/profile-db.ts:124

Whether the database belongs to a newer version and must not be written.

Methods

addBookmark()

addBookmark(parent, title, url?): number

Defined in: app/src/platform/data/profile-db.ts:298

Adds a bookmark or a folder at the end of a folder.

Parameters

parent

number

The folder.

title

string

Its title.

url?

string

The address of a bookmark; omitted for a folder.

Returns

number

The new id.

addDownload()

addDownload(url, path, total): number

Defined in: app/src/platform/data/profile-db.ts:429

Adds a download to the list, which keeps the most recent ones.

Parameters

url

string

The address it comes from.

path

string

The file it is saved to.

total

number

Its size in bytes, or 0 while unknown.

Returns

number

Its id.

addVisit()

addVisit(url, title?): void

Defined in: app/src/platform/data/profile-db.ts:163

Records a visit of a page.

Parameters

url

string

The page’s address.

title?

string = ''

Its title, if known yet.

Returns

void

bookmarkList()

bookmarkList(): BookmarkRow[]

Defined in: app/src/platform/data/profile-db.ts:312

Every bookmark and folder in display order: the two root folders first, then the contents of each folder in their order. Roots have no parent, folders no address.

Returns

BookmarkRow[]

bookmarks()

bookmarks(): BookmarkNode[]

Defined in: app/src/platform/data/profile-db.ts:256

The bookmarks: the bookmarks bar and the other bookmarks, with their folders.

Returns

BookmarkNode[]

bookmarkUrls()

bookmarkUrls(): string[]

Defined in: app/src/platform/data/profile-db.ts:325

The distinct addresses of all bookmarks.

Returns

string[]

clearHistory()

clearHistory(): void

Defined in: app/src/platform/data/profile-db.ts:227

Removes the whole history.

Returns

void

close()

close(): void

Defined in: app/src/platform/data/profile-db.ts:504

Closes the database.

Returns

void

deleteHistory()

deleteHistory(ids): void

Defined in: app/src/platform/data/profile-db.ts:220

Removes pages from the history.

Parameters

ids

readonly number[]

The pages.

Returns

void

downloads()

downloads(limit?): DownloadEntry[]

Defined in: app/src/platform/data/profile-db.ts:467

The most recent downloads, newest first. Downloads that were still running when the browser stopped are interrupted.

Parameters

limit?

number = 100

Most downloads to return.

Returns

DownloadEntry[]

history()

history(query, limit?, before?): HistoryEntry[]

Defined in: app/src/platform/data/profile-db.ts:190

Pages of the history, newest first, optionally matching search terms.

Parameters

query

string

Words that the title or address must contain; empty for all pages.

limit?

number = 100

The most pages to return.

before?

number = Number.MAX_SAFE_INTEGER

Only pages visited before this time.

Returns

HistoryEntry[]

importBookmarks()

importBookmarks(folderTitle, tree, source): number

Defined in: app/src/platform/data/profile-db.ts:389

Imports another browser’s bookmarks into a new folder of the other bookmarks. The folder of an earlier import from the same source is replaced, so importing again adds nothing.

Parameters

folderTitle

string

Title of the new folder, such as “Imported from Chrome”.

tree

readonly ImportedBookmark[]

The bookmarks and folders.

source

string

Identifies where the bookmarks come from, such as a browser profile.

Returns

number

How many bookmarks were imported.

importHistory()

importHistory(visits): number

Defined in: app/src/platform/data/profile-db.ts:238

Adds pages of another browser’s history; pages that exist keep the newer visit and the higher count of visits, so importing the same history again changes nothing.

Parameters

visits

readonly ImportedVisit[]

The pages.

Returns

number

How many pages were new.

interruptDownloads()

interruptDownloads(): void

Defined in: app/src/platform/data/profile-db.ts:486

Marks the downloads that were still running when the browser stopped as interrupted.

Returns

void

removeBookmark()

removeBookmark(id): void

Defined in: app/src/platform/data/profile-db.ts:366

Removes a bookmark or a folder with everything in it. The root folders stay.

Parameters

id

number

The bookmark or folder.

Returns

void

removeBookmarkUrl()

removeBookmarkUrl(url): void

Defined in: app/src/platform/data/profile-db.ts:376

Removes every bookmark of an address, for the star in the address bar.

Parameters

url

string

The address.

Returns

void

removeDownloads()

removeDownloads(ids): void

Defined in: app/src/platform/data/profile-db.ts:495

Removes downloads from the list; their files stay.

Parameters

ids

readonly number[]

The downloads.

Returns

void

setTitle()

setTitle(url, title): void

Defined in: app/src/platform/data/profile-db.ts:179

Updates the title of a page in the history.

Parameters

url

string

The page’s address.

title

string

Its new title.

Returns

void

updateBookmark()

updateBookmark(id, title, url?, parent?): void

Defined in: app/src/platform/data/profile-db.ts:341

Renames a bookmark or a folder, changes the address of a bookmark, and moves either to the end of another folder. The root folders stay as they are, and a folder never moves into itself or one of its own folders.