Interface EchoDatabase

interface EchoDatabase {
    coreDatabase: CoreDatabase;
    pendingBatch: ReadOnlyEvent<unknown>;
    query: QueryFn;
    get graph(): Hypergraph;
    get schemaRegistry(): EchoSchemaRegistry;
    get spaceId(): SpaceId;
    get spaceKey(): PublicKey;
    add<T extends BaseObject>(
        obj: Live<T>,
        opts?: AddOptions,
    ): AnyLiveObject<T>;
    flush(opts?: FlushOptions): Promise<void>;
    getObjectById<T extends BaseObject = any>(
        id: string,
        opts?: GetObjectByIdOptions,
    ): undefined | AnyLiveObject<T>;
    insert(data: InsertData): Promise<AnyObjectData>;
    insert(data: InsertBatch): Promise<AnyObjectData[]>;
    remove<T extends BaseObject>(obj: T): void;
    runMigrations(migrations: ObjectMigration[]): Promise<void>;
    toJSON(): object;
    update(filter: Filter.Any, operation: UpdateOperation): Promise<void>;
}

Index

Properties

`Readonly`coreDatabase

coreDatabase: CoreDatabase

Deprecated

`Readonly`pendingBatch

pendingBatch: ReadOnlyEvent<unknown>

Deprecated

query

query: QueryFn

Query objects.

Accessors

graph

get graph(): Hypergraph
Returns Hypergraph
- Defined in packages/core/echo/echo-db/dist/types/src/proxy-db/database.d.ts:34

schemaRegistry

get schemaRegistry(): EchoSchemaRegistry
Returns EchoSchemaRegistry
- Defined in packages/core/echo/echo-db/dist/types/src/proxy-db/database.d.ts:35

spaceId

get spaceId(): SpaceId
Returns SpaceId
- Defined in packages/core/echo/echo-db/dist/types/src/proxy-db/database.d.ts:37

spaceKey

get spaceKey(): PublicKey
Returns PublicKey
- Defined in packages/core/echo/echo-db/dist/types/src/proxy-db/database.d.ts:36

Methods

add

add<T extends BaseObject>(obj: Live<T>, opts?: AddOptions): AnyLiveObject<T>
Adds object to the database.
Type Parameters
- T extends BaseObject
Parameters
- obj: Live<T>
- Optionalopts: AddOptions
Returns AnyLiveObject<T>
- Defined in packages/core/echo/echo-db/dist/types/src/proxy-db/database.d.ts:47

flush

flush(opts?: FlushOptions): Promise<void>
Wait for all pending changes to be saved to disk.
Parameters
- Optionalopts: FlushOptions
Returns Promise<void>
- Defined in packages/core/echo/echo-db/dist/types/src/proxy-db/database.d.ts:55

getObjectById

getObjectById<T extends BaseObject = any>(
id: string,
opts?: GetObjectByIdOptions,
): undefined | AnyLiveObject<T>
Type Parameters
- T extends BaseObject = any
Parameters
- id: string
- Optionalopts: GetObjectByIdOptions
Returns undefined | AnyLiveObject<T>
- Defined in packages/core/echo/echo-db/dist/types/src/proxy-db/database.d.ts:39

insert

insert(data: InsertData): Promise<AnyObjectData>
Insert new objects.
Parameters
- data: InsertData
Returns Promise<AnyObjectData>
Deprecated
Use add instead.
- Defined in packages/core/echo/echo-db/dist/types/src/proxy-db/database.d.ts:65
insert(data: InsertBatch): Promise<AnyObjectData[]>
Parameters
- data: InsertBatch
Returns Promise<AnyObjectData[]>
- Defined in packages/core/echo/echo-db/dist/types/src/proxy-db/database.d.ts:66

remove

remove<T extends BaseObject>(obj: T): void
Removes object from the database.
Type Parameters
- T extends BaseObject
Parameters
- obj: T
Returns void
- Defined in packages/core/echo/echo-db/dist/types/src/proxy-db/database.d.ts:51

runMigrations

runMigrations(migrations: ObjectMigration[]): Promise<void>
Run migrations.
Parameters
- migrations: ObjectMigration[]
Returns Promise<void>
- Defined in packages/core/echo/echo-db/dist/types/src/proxy-db/database.d.ts:70

toJSON

toJSON(): object
Returns object
- Defined in packages/core/echo/echo-db/dist/types/src/proxy-db/database.d.ts:38

update

update(filter: Filter.Any, operation: UpdateOperation): Promise<void>
Update objects.
Parameters
- filter: Filter.Any
- operation: UpdateOperation
Returns Promise<void>
Deprecated
Use add instead.
- Defined in packages/core/echo/echo-db/dist/types/src/proxy-db/database.d.ts:60

Interface EchoDatabase

Index

Properties

Accessors

Methods

Properties

ReadonlycoreDatabase

Deprecated

ReadonlypendingBatch

Deprecated

query

Accessors

graph

Returns Hypergraph

schemaRegistry

Returns EchoSchemaRegistry

spaceId

Returns SpaceId

spaceKey

Returns PublicKey

Methods

add

Type Parameters

Parameters

Returns AnyLiveObject<T>

flush

Parameters

Returns Promise<void>

getObjectById

Type Parameters

Parameters

Returns undefined | AnyLiveObject<T>

insert

Parameters

Returns Promise<AnyObjectData>

Deprecated

Parameters

Returns Promise<AnyObjectData[]>

remove

Type Parameters

Parameters

Returns void

runMigrations

Parameters

Returns Promise<void>

toJSON

Returns object

update

Parameters

Returns Promise<void>

Deprecated

Settings

On This Page

`Readonly`coreDatabase

`Readonly`pendingBatch