Home Reference Source
public class | source

Search

Constructor Summary

Public Constructor
public

constructor(options: StorageOptions)

Member Summary

Public Members
public

Name of collection.

public

Connection string for search

public

Id field of records

Method Summary

Public Methods
public

async connect()

connect to search system

public abstract

async createRecord(record: *)

public abstract

async deleteRecord(record: *)

public abstract

async initialise(searchMeta: *, records: *)

Initialised search system with initial set of records

public abstract

async searchRecords(query: *)

public abstract

async updateRecord(record: *)

Public Constructors

public constructor(options: StorageOptions) source

Params:

NameTypeAttributeDescription
options StorageOptions

see fields

Public Members

public collectionName: * source

Name of collection. Derived from connection string if there is # based seperation.

public connectionString: * source

Connection string for search

public primaryKey: * source

Id field of records

Public Methods

public async connect() source

connect to search system

public abstract async createRecord(record: *) source

Params:

NameTypeAttributeDescription
record *

public abstract async deleteRecord(record: *) source

Params:

NameTypeAttributeDescription
record *

public abstract async initialise(searchMeta: *, records: *) source

Initialised search system with initial set of records

Params:

NameTypeAttributeDescription
searchMeta *
records *

public abstract async searchRecords(query: *) source

Params:

NameTypeAttributeDescription
query *

public abstract async updateRecord(record: *) source

Params:

NameTypeAttributeDescription
record *