Methods create From Schema create From Schema ( config ) : Promise < Collection < Properties , string > > Parameters config : { class ?: string ; description ?: string ; invertedIndexConfig ?: { bm25 ?: { b ?: number ; k1 ?: number ; } ; cleanupIntervalSeconds ?: number ; indexNullState ?: boolean ; indexPropertyLength ?: boolean ; indexTimestamps ?: boolean ; stopwords ?: { additions ?: string [] ; preset ?: string ; removals ?: string [] ; } ; } ; moduleConfig ?: { [key : string ]: unknown ; } ; multiTenancyConfig ?: { autoTenantActivation ?: boolean ; autoTenantCreation ?: boolean ; enabled ?: boolean ; } ; properties ?: { dataType ?: string [] ; description ?: string ; indexFilterable ?: boolean ; indexInverted ?: boolean ; indexRangeFilters ?: boolean ; indexSearchable ?: boolean ; moduleConfig ?: { [key : string ]: unknown ; } ; name ?: string ; nestedProperties ?: { dataType ?: string [] ; description ?: string ; indexFilterable ?: boolean ; indexRangeFilters ?: boolean ; indexSearchable ?: boolean ; name ?: string ; nestedProperties ?: { dataType?: string[] | undefined; description?: string | undefined; name?: string | undefined; indexFilterable?: boolean | undefined; indexSearchable?: boolean | undefined; indexRangeFilters?: boolean | undefined; tokenization?: "word" | ... 3 more ... | undefined; nestedProperties?: ...[] | undefined; }[] | undefi...; tokenization ?: "word" | "lowercase" | "whitespace" | "field" ; } [] ; tokenization ?: "word" | "lowercase" | "whitespace" | "field" | "trigram" | "gse" | "kagome_kr" ; } [] ; replicationConfig ?: { asyncEnabled ?: boolean ; factor ?: number ; } ; shardingConfig ?: { [key : string ]: unknown ; } ; vectorConfig ?: { [key : string ]: definitions [ "VectorConfig" ] ; } ; vectorIndexConfig ?: { [key : string ]: unknown ; } ; vectorIndexType ?: string ; vectorizer ?: string ; } Optional
class ?: string Optional
description ?: string Optional
inverted Index Config ?: { bm25 ?: { b ?: number ; k1 ?: number ; } ; cleanupIntervalSeconds ?: number ; indexNullState ?: boolean ; indexPropertyLength ?: boolean ; indexTimestamps ?: boolean ; stopwords ?: { additions ?: string [] ; preset ?: string ; removals ?: string [] ; } ; } Optional
bm25 ?: { b ?: number ; k1 ?: number ; } Optional
b ?: number Optional
k1 ?: number Optional
cleanup Interval Seconds ?: number Optional
index Null State ?: boolean Optional
index Property Length ?: boolean Optional
index Timestamps ?: boolean Optional
stopwords ?: { additions ?: string [] ; preset ?: string ; removals ?: string [] ; } Optional
additions ?: string [] Optional
preset ?: string Optional
removals ?: string [] Optional
module Config ?: { [key : string ]: unknown ; } Optional
multi Tenancy Config ?: { autoTenantActivation ?: boolean ; autoTenantCreation ?: boolean ; enabled ?: boolean ; } Optional
auto Tenant Activation ?: boolean Optional
auto Tenant Creation ?: boolean Optional
enabled ?: boolean Optional
properties ?: { dataType ?: string [] ; description ?: string ; indexFilterable ?: boolean ; indexInverted ?: boolean ; indexRangeFilters ?: boolean ; indexSearchable ?: boolean ; moduleConfig ?: { [key : string ]: unknown ; } ; name ?: string ; nestedProperties ?: { dataType ?: string [] ; description ?: string ; indexFilterable ?: boolean ; indexRangeFilters ?: boolean ; indexSearchable ?: boolean ; name ?: string ; nestedProperties ?: { dataType?: string[] | undefined; description?: string | undefined; name?: string | undefined; indexFilterable?: boolean | undefined; indexSearchable?: boolean | undefined; indexRangeFilters?: boolean | undefined; tokenization?: "word" | ... 3 more ... | undefined; nestedProperties?: ...[] | undefined; }[] | undefi...; tokenization ?: "word" | "lowercase" | "whitespace" | "field" ; } [] ; tokenization ?: "word" | "lowercase" | "whitespace" | "field" | "trigram" | "gse" | "kagome_kr" ; } [] Optional
replication Config ?: { asyncEnabled ?: boolean ; factor ?: number ; } Optional
async Enabled ?: boolean Optional
factor ?: number Optional
sharding Config ?: { [key : string ]: unknown ; } Optional
vector Config ?: { [key : string ]: definitions [ "VectorConfig" ] ; } [ key : string ]: definitions [ "VectorConfig" ] Optional
vector Index Config ?: { [key : string ]: unknown ; } Optional
vector Index Type ?: string Optional
vectorizer ?: string delete delete ( collection ) : Promise < void > Returns Promise < void > delete All delete All ( ) : Promise < void [] > Returns Promise < void [] > exists exists ( name ) : Promise < boolean > Returns Promise < boolean >
Description
Name of the class as URI relative to the schema URL.