BaseFilesystem

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:80

A synchronous virtual filesystem that holds a data directory, mounted by a Postgres build in place of its built-in storage (pass it as createPgwasm({ fs })). Paths are absolute within the filesystem, /-separated, / being the data directory itself.

Besides the POSIX-shaped operations, a filesystem takes part in durability: pgwasm calls syncToFs(relaxed) after statements (see createPgwasm’s relaxedDurability), the build calls initialSyncFs() once when it mounts the filesystem, closeFs() when the database closes and cleanupFailedInit() when a boot fails after the filesystem was handed over.

Extended by

• OpfsRepackedFS

Constructors

Constructor

new BaseFilesystem(__namedParameters?): BaseFilesystem

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:84

Parameters

__namedParameters?

debug?

boolean = false

Returns

BaseFilesystem

Properties

debug

readonly debug: boolean

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:81

Accessors

description

Get Signature

get description(): FilesystemDescription

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:93

What this filesystem is, as pg.storage reports it. Defaults to { name: "custom" }, persistence undeclared: a filesystem overrides it to name itself and to say whether its data outlives the process (persistent: true) or not (persistent: false), since nothing else can tell.

Returns

FilesystemDescription

---

recentSyscallErrors

Get Signature

get recentSyscallErrors(): readonly SyscallError[]

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:98

The most recent failed filesystem calls reported to Postgres (up to 50), oldest first.

Returns

readonly SyscallError[]

Methods

chmod()

abstract chmod(path, mode): void

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:128

Parameters

path

string

mode

number

Returns

void

---

cleanupFailedInit()

cleanupFailedInit(): Promise<void>

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:124

Release what the filesystem holds after a boot failed. Defaults to closeFs.

Returns

Promise<void>

---

close()

abstract close(fd): void

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:129

Parameters

fd

number

Returns

void

---

closeFs()

closeFs(): Promise<void>

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:121

Release everything the filesystem holds. Called when the database closes.

Returns

Promise<void>

---

fstat()

abstract fstat(fd): FsStats

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:130

Parameters

fd

number

Returns

FsStats

---

initialSyncFs()

initialSyncFs(): Promise<void>

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:118

Called once when the build mounts the filesystem, before anything reads it.

Returns

Promise<void>

---

lstat()

abstract lstat(path): FsStats

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:131

Parameters

path

string

Returns

FsStats

---

mkdir()

abstract mkdir(path, options?): void

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:132

Parameters

path

string

options?

mode?

number

recursive?

boolean

Returns

void

---

open()

abstract open(path, flags?, mode?): number

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:133

Parameters

path

string

flags?

string

mode?

number

Returns

number

---

read()

abstract read(fd, buffer, offset, length, position): number

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:136

Read into buffer[offset, offset + length) from position; returns the bytes read.

Parameters

fd

number

buffer

Uint8Array

offset

number

length

number

position

number

Returns

number

---

readdir()

abstract readdir(path): string[]

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:134

Parameters

path

string

Returns

string[]

---

recordSyscallError()

recordSyscallError(op, path, errno, message): void

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:103

Record a failed call. The build’s mount calls this where it turns a thrown error into an errno.

Parameters

op

string

path

string

errno

number

message

string

Returns

void

---

rename()

abstract rename(oldPath, newPath): void

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:137

Parameters

oldPath

string

newPath

string

Returns

void

---

rmdir()

abstract rmdir(path): void

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:138

Parameters

path

string

Returns

void

---

syncToFs()

syncToFs(_relaxed?): Promise<void>

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:115

Make everything written so far durable. relaxed is pgwasm’s background persist.

Parameters

_relaxed?

boolean

Returns

Promise<void>

---

truncate()

abstract truncate(path, length): void

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:139

Parameters

path

string

length

number

Returns

void

---

unlink()

abstract unlink(path): void

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:140

Parameters

path

string

Returns

void

---

utimes()

abstract utimes(path, atime, mtime): void

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:141

Parameters

path

string

atime

number

mtime

number

Returns

void

---

write()

abstract write(fd, buffer, offset, length, position): number

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:148

Write buffer[offset, offset + length) at position; returns the bytes written.

Parameters

fd

number

buffer

Uint8Array

offset

number

length

number

position

number

Returns

number

---

writeFile()

abstract writeFile(path, data, options?): void

Defined in: packages/pgwasm/src/fs/base-filesystem.ts:142

Parameters

path

string

data

string | Uint8Array<ArrayBufferLike>

options?

encoding?

string

flag?

string

mode?

number

Returns

void