Skip to content
1 min read · 211 words

Class: CollectionBuilder

Defined in: batteries/vector/schema.ts:17

Constructors

Constructor

ts
new CollectionBuilder(): CollectionBuilder;

Returns

CollectionBuilder

Methods

boolean()

ts
boolean(name: string): FieldChain;

Defined in: batteries/vector/schema.ts:41

Parameters

ParameterType
namestring

Returns

FieldChain


build()

ts
build(collection: string): CollectionSpec;

Defined in: batteries/vector/schema.ts:60

Parameters

ParameterType
collectionstring

Returns

CollectionSpec


integer()

ts
integer(name: string): FieldChain;

Defined in: batteries/vector/schema.ts:33

Parameters

ParameterType
namestring

Returns

FieldChain


json()

ts
json(name: string): FieldChain;

Defined in: batteries/vector/schema.ts:45

Parameters

ParameterType
namestring

Returns

FieldChain


number()

ts
number(name: string): FieldChain;

Defined in: batteries/vector/schema.ts:37

Parameters

ParameterType
namestring

Returns

FieldChain


string()

ts
string(name: string): FieldChain;

Defined in: batteries/vector/schema.ts:29

Parameters

ParameterType
namestring

Returns

FieldChain


vector()

ts
vector(def: {
  dimensions: number;
  metric?: DistanceMetric;
}): this;

Defined in: batteries/vector/schema.ts:21

Parameters

ParameterType
def{ dimensions: number; metric?: DistanceMetric; }
def.dimensionsnumber
def.metric?DistanceMetric

Returns

this