CollectionSchemaRegistry class abstract interface

Abstract registry that stores active schemas.

Implementers

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

beginMigrationLog({required String collection, required int fromVersion, required int toVersion, String? migrationId}) Future<String?>
Optional hook for logging migrations. Default no-op.
clearCheckpoint(String collection) Future<void>
ensureReady() Future<void>
finishMigrationLog({String? logId, required String collection, required bool success, List<SchemaMigrationError> errors = const []}) Future<void>
Optional hook for finishing migration log. Default no-op.
getActiveSchema(String collection) Future<CollectionSchema?>
loadAllActiveSchemas() Future<Map<String, CollectionSchema>>
loadCheckpoint(String collection) Future<SchemaMigrationCheckpoint?>
Optional persistence for checkpoints. Default no-op.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
recordSchemaHistory({required String collection, required int version, required Map<String, dynamic> schema, String? migrationId}) Future<void>
Optional hook to store historical schema versions.
saveCheckpoint(SchemaMigrationCheckpoint checkpoint) Future<void>
setPolicy({required String collection, required CollectionSchemaPolicy policy}) Future<CollectionSchemaPolicy>
toString() String
A string representation of this object.
inherited
upsertSchema({required String collection, required int version, required Map<String, dynamic> schema, CollectionSchemaPolicy? policy}) Future<CollectionSchema>

Operators

operator ==(Object other) bool
The equality operator.
inherited