UpdateField class
Used to update a colletion's fields.
Since Typesense currently only supports adding/deleting a field, any modifications to an existing field should be expressed as a drop + add operation.
Constructors
- UpdateField(String name, {Type? type, bool isMultivalued = false, int dimensions = 0, bool isOptional = false, bool isFacetable = false, bool shouldIndex = true, String? locale, bool sort = false, bool enableInfixSearch = false, bool shouldDrop = false})
-
UpdateField.fromMap(Map<
String, dynamic> map) -
factory
Properties
- dimensions → int
-
Used in case of a vector field. Represents the number of dimensions
(length of the float array) that your embeddings contain.
finalinherited
- enableInfixSearch → bool
-
Enable infix search on a string field.
finalinherited
- hashCode → int
-
The hash code for this object.
no setteroverride
- isFacetable → bool
-
If this field will be used in faceted search.
finalinherited
- isMultivalued → bool
-
If this field is an array containing multiple values.
finalinherited
- isOptional → bool
-
If this field can be ommited in a document.
finalinherited
- locale → String?
-
finalinherited
- name → String
-
name of the field.
finalinherited
- reference → String?
-
Connects a document to a field in another collection.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- shouldDrop → bool
-
If this field should be dropped during collection update operation.
final
- shouldIndex → bool
-
Declaring a field as non-indexable
finalinherited
- sort → bool
-
Enable sorting on a string field.
finalinherited
- type → Type?
-
Type of field.
finalinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override