Class CereusDB

Index

Methods

dropTable registerFile registerGeoJSON registerGeoTIFF registerRaster registerRemoteParquet sql sqlJSON tables version create

Methods

dropTable

dropTable(name: string): void
Drop a table.
Parameters
- name: string
Returns void
- Defined in index.d.ts:59

registerFile

registerFile(name: string, file: File): Promise<void>
Register a local file (from File API / drag-and-drop) as a table. Currently supports Parquet, GeoJSON, and GeoTIFF rasters.
Parameters
- name: string
- file: File
Returns Promise<void>
- Defined in index.d.ts:43

registerGeoJSON

registerGeoJSON(name: string, geojson: string | object): void
Register a GeoJSON object or string as a table.
Parameters
- name: string
- geojson: string | object
Returns void
- Defined in index.d.ts:47

registerGeoTIFF

registerGeoTIFF(name: string, data: BufferSource): void
Register a GeoTIFF buffer as a single-column raster table. Requires the full GDAL-enabled package build.
Parameters
- name: string
- data: BufferSource
Returns void
- Defined in index.d.ts:57

registerRaster

registerRaster(name: string, data: BufferSource, format: RasterFormat): void
Register a raster buffer as a single-column raster table. Requires the full GDAL-enabled package build.
Parameters
- name: string
- data: BufferSource
- format: RasterFormat
Returns void
- Defined in index.d.ts:52

registerRemoteParquet

registerRemoteParquet(name: string, url: string): Promise<void>
Register a remote Parquet file as a table. The server must support CORS.
Parameters
- name: string
- url: string
Returns Promise<void>
- Defined in index.d.ts:38

sql

sql(query: string): Promise<Uint8Array<ArrayBuffer>>
Execute a SQL query and return results as Arrow IPC bytes.
Parameters
- query: string
Returns Promise<Uint8Array<ArrayBuffer>>
- Defined in index.d.ts:29

sqlJSON

sqlJSON(query: string): Promise<Record<string, unknown>[]>
Execute a SQL query and return results as JSON.
Parameters
- query: string
Returns Promise<Record<string, unknown>[]>
- Defined in index.d.ts:33

tables

tables(): string[]
List registered tables.

Returns string[]
- Defined in index.d.ts:61

version

version(): string
Version string.

Returns string
- Defined in index.d.ts:63

`Static`create

create(options?: CereusDBOptions): Promise<CereusDB>
Create and initialize a new CereusDB instance. This loads the WASM module and initializes the query engine.
Parameters
- Optionaloptions: CereusDBOptions
Returns Promise<CereusDB>
- Defined in index.d.ts:25