OpfsRepackedFS
Defined in: packages/pglite-opfs-repacked/src/opfs-repacked-fs.ts:25
PGlite filesystem adapter owned by createOpfsRepackedPGlite.
Direct construction is unsupported. The factory retains this adapter so it can close all four handles when host initialization or shutdown fails.
Extends
Section titled “Extends”BaseFilesystem
Properties
Section titled “Properties”
readonlydebug:boolean
Defined in: node_modules/.bun/@pgxsinkit+pglite@0.5.4-pgx.11/node_modules/@pgxsinkit/pglite/dist/pglite-DWiE6ARG.d.ts:395
Inherited from
Section titled “Inherited from”BaseFilesystem.debug
Accessors
Section titled “Accessors”recentSyscallErrors
Section titled “recentSyscallErrors”Get Signature
Section titled “Get Signature”get recentSyscallErrors(): readonly
SyscallError[]
Defined in: node_modules/.bun/@pgxsinkit+pglite@0.5.4-pgx.11/node_modules/@pgxsinkit/pglite/dist/pglite-DWiE6ARG.d.ts:403
The most recent syscall failures (up to MAX_SYSCALL_ERRORS) that the emscripten FS wrapper converted into errno results. Oldest first.
Returns
Section titled “Returns”readonly SyscallError[]
Inherited from
Section titled “Inherited from”BaseFilesystem.recentSyscallErrors
Methods
Section titled “Methods”chmod()
Section titled “chmod()”chmod(
path,mode):void
Defined in: packages/pglite-opfs-repacked/src/opfs-repacked-fs.ts:68
Parameters
Section titled “Parameters”string
number
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”BaseFilesystem.chmod
close()
Section titled “close()”close(
fd):void
Defined in: packages/pglite-opfs-repacked/src/opfs-repacked-fs.ts:72
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”BaseFilesystem.close
closeFs()
Section titled “closeFs()”closeFs():
Promise<void>
Defined in: packages/pglite-opfs-repacked/src/opfs-repacked-fs.ts:60
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”BaseFilesystem.closeFs
dumpTar()
Section titled “dumpTar()”dumpTar(
dbname,compression?):Promise<Blob|File>
Defined in: node_modules/.bun/@pgxsinkit+pglite@0.5.4-pgx.11/node_modules/@pgxsinkit/pglite/dist/pglite-DWiE6ARG.d.ts:413
Dump the PGDATA dir from the filesystem to a gzipped tarball.
Parameters
Section titled “Parameters”dbname
Section titled “dbname”string
compression?
Section titled “compression?”DumpTarCompressionOptions
Returns
Section titled “Returns”Promise<Blob | File>
Inherited from
Section titled “Inherited from”BaseFilesystem.dumpTar
fstat()
Section titled “fstat()”fstat(
fd):FsStats
Defined in: packages/pglite-opfs-repacked/src/opfs-repacked-fs.ts:76
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”FsStats
Overrides
Section titled “Overrides”BaseFilesystem.fstat
init()
Section titled “init()”init(
pg,emscriptenOptions):Promise<{emscriptenOpts:Partial<PostgresMod>; }>
Defined in: node_modules/.bun/@pgxsinkit+pglite@0.5.4-pgx.11/node_modules/@pgxsinkit/pglite/dist/pglite-DWiE6ARG.d.ts:414
Initiate the filesystem and return the options to pass to the emscripten module.
Parameters
Section titled “Parameters”PGlite
emscriptenOptions
Section titled “emscriptenOptions”Partial<PostgresMod>
Returns
Section titled “Returns”Promise<{ emscriptenOpts: Partial<PostgresMod>; }>
Inherited from
Section titled “Inherited from”BaseFilesystem.init
initialSyncFs()
Section titled “initialSyncFs()”initialSyncFs():
Promise<void>
Defined in: packages/pglite-opfs-repacked/src/opfs-repacked-fs.ts:35
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”BaseFilesystem.initialSyncFs
lstat()
Section titled “lstat()”lstat(
path):FsStats
Defined in: packages/pglite-opfs-repacked/src/opfs-repacked-fs.ts:80
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”FsStats
Overrides
Section titled “Overrides”BaseFilesystem.lstat
mkdir()
Section titled “mkdir()”mkdir(
path,options?):void
Defined in: packages/pglite-opfs-repacked/src/opfs-repacked-fs.ts:84
Parameters
Section titled “Parameters”string
options?
Section titled “options?”number
recursive?
Section titled “recursive?”boolean
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”BaseFilesystem.mkdir
open()
Section titled “open()”open(
path,flags?,mode?):number
Defined in: packages/pglite-opfs-repacked/src/opfs-repacked-fs.ts:92
Parameters
Section titled “Parameters”string
flags?
Section titled “flags?”string = "r+"
number = 0o100666
Returns
Section titled “Returns”number
Overrides
Section titled “Overrides”BaseFilesystem.open
read()
Section titled “read()”read(
fd,buffer,offset,length,position):number
Defined in: packages/pglite-opfs-repacked/src/opfs-repacked-fs.ts:100
Parameters
Section titled “Parameters”number
buffer
Section titled “buffer”Uint8Array
offset
Section titled “offset”number
length
Section titled “length”number
position
Section titled “position”number
Returns
Section titled “Returns”number
Overrides
Section titled “Overrides”BaseFilesystem.read
readdir()
Section titled “readdir()”readdir(
path):string[]
Defined in: packages/pglite-opfs-repacked/src/opfs-repacked-fs.ts:96
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”string[]
Overrides
Section titled “Overrides”BaseFilesystem.readdir
recordSyscallError()
Section titled “recordSyscallError()”recordSyscallError(
op,path,errno,message):void
Defined in: node_modules/.bun/@pgxsinkit+pglite@0.5.4-pgx.11/node_modules/@pgxsinkit/pglite/dist/pglite-DWiE6ARG.d.ts:409
Record a syscall failure into the ring buffer. Called by the emscripten FS wrapper at the point it converts a thrown error into an errno result. The allocation only happens when an error actually occurs.
Parameters
Section titled “Parameters”string
string
number
message
Section titled “message”string
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”BaseFilesystem.recordSyscallError
rename()
Section titled “rename()”rename(
oldPath,newPath):void
Defined in: packages/pglite-opfs-repacked/src/opfs-repacked-fs.ts:104
Parameters
Section titled “Parameters”oldPath
Section titled “oldPath”string
newPath
Section titled “newPath”string
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”BaseFilesystem.rename
rmdir()
Section titled “rmdir()”rmdir(
path):void
Defined in: packages/pglite-opfs-repacked/src/opfs-repacked-fs.ts:108
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”BaseFilesystem.rmdir
strictSync()
Section titled “strictSync()”strictSync():
void
Defined in: packages/pglite-opfs-repacked/src/opfs-repacked-fs.ts:47
Stabilize every preceding data and metadata operation in strict order.
Returns
Section titled “Returns”void
syncToFs()
Section titled “syncToFs()”syncToFs(
relaxedDurability?):Promise<void>
Defined in: packages/pglite-opfs-repacked/src/opfs-repacked-fs.ts:39
Parameters
Section titled “Parameters”relaxedDurability?
Section titled “relaxedDurability?”boolean = false
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”BaseFilesystem.syncToFs
truncate()
Section titled “truncate()”truncate(
path,length):void
Defined in: packages/pglite-opfs-repacked/src/opfs-repacked-fs.ts:112
Parameters
Section titled “Parameters”string
length
Section titled “length”number
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”BaseFilesystem.truncate
unlink()
Section titled “unlink()”unlink(
path):void
Defined in: packages/pglite-opfs-repacked/src/opfs-repacked-fs.ts:116
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”BaseFilesystem.unlink
utimes()
Section titled “utimes()”utimes(
path,atime,mtime):void
Defined in: packages/pglite-opfs-repacked/src/opfs-repacked-fs.ts:120
Parameters
Section titled “Parameters”string
number
number
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”BaseFilesystem.utimes
write()
Section titled “write()”write(
fd,buffer,offset,length,position):number
Defined in: packages/pglite-opfs-repacked/src/opfs-repacked-fs.ts:137
Parameters
Section titled “Parameters”number
buffer
Section titled “buffer”Uint8Array
offset
Section titled “offset”number
length
Section titled “length”number
position
Section titled “position”number
Returns
Section titled “Returns”number
Overrides
Section titled “Overrides”BaseFilesystem.write
writeFile()
Section titled “writeFile()”writeFile(
path,data,options?):void
Defined in: packages/pglite-opfs-repacked/src/opfs-repacked-fs.ts:124
Parameters
Section titled “Parameters”string
string | Uint8Array<ArrayBufferLike>
options?
Section titled “options?”encoding?
Section titled “encoding?”string
string
number
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”BaseFilesystem.writeFile