CollectionInstruction class abstract
Represents a migration instruction set for NitriteCollection.
- Implemented types
Constructors
Properties
- collectionName → String
-
The name of the collection for this instruction.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addField(
String fieldName, {dynamic defaultValue, Generator? generator}) → CollectionInstruction - Adds an instruction to add a new field with either a default value or a value generator, into the document of a NitriteCollection.
-
addStep(
MigrationStep step) → void -
Adds a migration step to the instruction set.
inherited
-
createIndex(
String indexType, List< String> fieldNames) → CollectionInstruction - Adds an instruction to create an index in a NitriteCollection.
-
deleteField(
String fieldName) → CollectionInstruction - Adds an instruction to delete a field from the document of a NitriteCollection.
-
dropAllIndices(
) → CollectionInstruction - Adds an instruction to drop all indices from a NitriteCollection.
-
dropIndex(
List< String> indexedFieldNames) → CollectionInstruction - Adds an instruction to drop an index from a NitriteCollection.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
rename(
String name) → CollectionInstruction - Adds an instruction to rename a NitriteCollection.
-
renameField(
String oldName, String newName) → CollectionInstruction - Adds an instruction to rename a field to the document of a NitriteCollection.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited