@peerbit/indexer-tests
v1.1.3
Published
Tests document store index engines
Downloads
54
Readme
Documents
Distributed document store.
This store is built on top of the base store. This store allows for type-safe document storage and retrieval accross peers.
As of now, go through the tests for documentation on how to use the module.
Example
import { field, option, serialize, variant } from "@dao-xyz/borsh";
import { Program } from "@peerbit/program";
import { Peerbit } from "peerbit";
import {
Documents,
DocumentIndex,
SearchRequest,
StringMatch,
StringMatchMethod,
Results,
} from "@peerbit/document";
@variant("document")
class Document {
@field({ type: "string" })
id: string;
@field({ type: option("string") })
name?: string;
@field({ type: option("u64") })
number?: bigint;
constructor(opts?: Document) {
if (opts) {
Object.assign(this, opts);
}
}
}
@variant("test_documents")
class TestStore extends Program {
@field({ type: Documents })
docs: Documents<Document>;
constructor(properties?: { docs: Documents<Document> }) {
super();
if (properties) {
this.docs = properties.docs;
}
}
async open(): Promise<void> {
await this.docs.open({
type: Document,
index: {
fields: (obj) => obj // here you can filter and transform what fields you want to index
}})
}
}
// later
const peer = await Peerbit.create ({libp2p: your_libp2p_instance})
const store = peer.open(new TestStore());
console.log(store.address) /// this address can be opened by another peer
// insert
let doc = new Document({
id: "1",
name: "hello world",
number: 1n,
});
let doc2 = new Document({
id: "2",
name: "hello world",
number: 2n,
});
let doc3 = new Document({
id: "3",
name: "foo",
number: 3n,
});
await store.docs.put(doc);
await store.docs.put(doc2);
await store.docs.put(doc3);
// search for documents from another peer
const peer2 = await Peerbit.create ({libp2: another_libp2p_instance})
const store2 = peer2.open(store.address);
let responses: Document[] = await store2.docs.index.search(
new SearchRequest({
query: [
new StringMatch({
key: "name",
value: "ello",
method: StringMatchMethod.contains
}),
],
})
);
expect(responses]).to.have.length(2);
expect(responses.map((x) => x.value.id)).to.deep.equal(["1", "2"]);