ModelServerCommandDeleteDocumentsSchedule class
ModelServerCommandBase
to delete all documents for the collection specified in time.
Specify the path of the collection to be deleted in collectionPath.
where allows you to specify conditions for retrieving data from a collection. In addition, it is possible to specify conditions for the retrieved data in conditions.
No problem even if the number of documents in the collection is large, as they are deleted in a batch process.
If you use this in firestore, please specify the fields _time
and _done
in CollectionID:schedule
to create the index.
timeに指定されたコレクションに対するすべてのドキュメントを削除するためのModelServerCommandBase
です。
collectionPathに削除対象のコレクションのパスを指定します。
whereでコレクションからの取得条件を指定することが可能です。また、conditionsで取得したデータに対する条件を指定することが可能です。
バッチ処理で削除されるためコレクション内のドキュメントの数が多い場合でも問題ございません。
firestoreでこちらを利用する場合CollectionID:schedule
で_time
と_done
のフィールドを指定してインデックスを作成してください。
Constructors
-
ModelServerCommandDeleteDocumentsSchedule({required String collectionPath, List<
ModelServerCommandCondition> ? where, List<ModelServerCommandCondition> ? conditions, required ModelTimestamp time}) -
ModelServerCommandBase
to delete all documents for the collection specified intime
.constfactory - ModelServerCommandDeleteDocumentsSchedule.fromJson(DynamicMap json)
-
Convert from
json
map to ModelServerCommandCopyDocumentSchedule.factory - ModelServerCommandDeleteDocumentsSchedule.fromServer({DynamicMap publicParameters = const {}, DynamicMap privateParameters = const {}})
-
Used to disguise the retrieval of data from the server.
const
Properties
- collectionPath → String
-
Path of the collection from which to retrieve the list of documents to be deleted.
no setter
-
conditions
→ List<
ModelServerCommandCondition> ? -
Specify the condition for the acquired data.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- privateParameters → DynamicMap
-
Private parameters for the command.
no setteroverride
- publicParameters → DynamicMap
-
Public parameters for the command.
no setteroverride
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- time → ModelTimestamp
-
Specify the date and time to copy.
no setter
- value → String
-
Actual value.
no setterinherited
-
where
→ List<
ModelServerCommandCondition> ? -
Specifies the conditions for retrieving from the collection.
no setter
Methods
-
compareTo(
ModelServerCommandBase other) → int -
Compares this object to another object.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → DynamicMap -
Methods for Json serialization.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited