Home Reference Source
import IFTSSchema from 'indexedfts/lib/Schema.js'
public class | source

IFTSSchema

The database schema of IndexedFTS.

Constructor Summary

Public Constructor
public

constructor(schema: object)

Create IFTSSchema.

Member Summary

Public Members
public get

All column names that indexed in some way.

public

Column names that indexed with ngram for full-text search.

public

Column names that normal indexed.

public

Primary key of this schema.

public

Column names that unique indexed.

public

Column names that indexed with word for full-text search.

Public Constructors

public constructor(schema: object) source

Create IFTSSchema.

Params:

NameTypeAttributeDescription
schema object

please see same name param of IndexedFTS#constructor.

Throw:

InvalidSchemaError

Public Members

public get indexes: Set<string> source

All column names that indexed in some way.

public ngramIndexes: Set<string> source

Column names that indexed with ngram for full-text search.

public normalIndexes: Set<string> source

Column names that normal indexed.

public primaryKey: string | null source

Primary key of this schema.

This value will be null if not set primary key.

public uniqueIndexes: Set<string> source

Column names that unique indexed.

public wordIndexes: Set<string> source

Column names that indexed with word for full-text search.